Update documentation

README.md

@@ -1,11 +1,44 @@
 # Report-link-action
 
-Action that reports incorrect in repository documentation eg. expired links as new issues.
+Action that reports incorrect links as new issue. Thanks to this, it facilitates keeping documentation constantly in good condition.
 
-## Inputs
+## Usage
 
-## Example usage
+### Example Workflow file
 
-## Tests
+An example workflow to authenticate with GitHub Platform:
 
-* [Example invalid link](http://invalid-link.example.com)
+```yaml
+on:
+  branches:
+      - master
+  schedule:
+  # Run at 12:00 in working days
+  - cron: 0 12 * * 0-5
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Push changes
+      uses: ad-m/report-link-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### Inputs
+
+| name | value | default | description |
+| ---- | ----- | ------- | ----------- |
+| github_token | string | | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}`. |
+
+PR is welcome to add additional parameters to the needs of the user eg. customize directory, labels, content, title, format (RST etc.).
+
+## License
+
+The Dockerfile and associated scripts and documentation in this project are released under the [MIT License](LICENSE).
+
+## No affiliation with GitHub Inc.
+
+GitHub are registered trademarks of GitHub, Inc. GitHub name used in this project are for identification purposes only. The project is not associated in any way with GitHub Inc. and is not an official solution of GitHub Inc. It was made available in order to facilitate the use of the site GitHub.

action.yml

@@ -2,7 +2,7 @@ name: 'Report-link-action'
 description: 'Action that reports incorrect in repository documentation eg. expired links as new issues.'
 inputs:
   github_token:
-    description: 'GitHub access token'
+    description: 'Token for the repo. Can be passed in using $\{{ secrets.GITHUB_TOKEN }}'
     required: true
 runs:
   using: 'docker'