diff --git a/README.md b/README.md index 3aebf8d..18cf33f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # Miron-Insights Simple python script to get Miron insights automatically + +# Dependencies + +Python3 and PyGithub: +`pip install PyGithub` + +# How to use +Navigate to the folder Miron-Insights and run: + +`python3 insights.py "username" "password"` + +Replace "username" and "password" with your info. + +You should get something like this, in terminal: + +`['Unique Views', 4, 8, 3, 5, 1, 0, 0] +['Views Count', 59, 51, 18, 13, 4, 0, 0] +['Unique Clones', 1, 0, 5, 1, 1, 0, 0] +['Views Count', 59, 51, 18, 13, 4, 0, 0]` + +It also generates a .csv file with the total. The csv file's name is current date and the results have 1 week timestamp.