docs: added readme

README.md

@@ -1 +1,21 @@
-# mawesome
+# mawesome
+
+This action query the github api to get starred list of the user and then generates a list ordered by languages. 
+
+## Inputs
+
+### `github-token`
+
+The github workflow token is `required`
+
+## Outputs
+
+Output the generated list in the project `README.md`
+
+## Example usage
+
+```yml
+  uses: simonecorsi/mawesome@v1
+  with:
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+```