add readme sections

README.md

@@ -1,7 +1,26 @@
-## Things to put in readme
+## Codecov Github Action
+### Easily upload coverage reports to Codecov from Github Actions 
 
-* A detailed description of what the action does.
+## Usage
-* Environment variables the action uses.
+
-* Secrets the action uses. Production secrets should not be stored in the API during the limited public beta period.
+Inside your `.github/workflows/workflow.yml` file:
-* Required arguments.
+
-* Optional arguments.
+```yaml
+steps:
+- uses: actions/checkout@master
+- uses: actions/codecov-action@v1
+  with:
+    token: ${{secrets.CODECOV_TOKEN}}
+```
+>**Note**: This assumes that you've set your Codecov token inside settings > secrets as `CODECOV_TOKEN`. If not, you can get an upload token for your specific repo on codecov.io 
+
+## Arguments
+
+| Argument  | Description |
+| :---:     |     :---:   | 
+| `token`  | Used to authorize coverage report uploads  |
+
+
+## License 
+
+The code in this project is released under the MIT License

action.yml

@@ -1,9 +1,10 @@
 name: 'Codecov'
-description: 'Github action that uploads coverage reports for this repository to codecov.io'
+description: 'Github action that uploads coverage reports for your repository to codecov.io'
 author: 'Ib @ Codecov'
 inputs: 
   token:
-    description: 'Set the repository token' 
+    description: 'Set the repository token'
+    required: true 
 branding:
   color: 'red' 
   icon: 'umbrella'