From e1c9ca0a6f1923d8d1fc897abad47694e7c31dd8 Mon Sep 17 00:00:00 2001
From: Simone Corsi <simonecorsi.rm@gmail.com>
Date: Sat, 16 Jan 2021 09:09:24 +0100
Subject: [PATCH] docs: added readme

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 22ccbed..ef85a35 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
-# mawesome
\ No newline at end of file
+# 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 }}
+```