From dbde9f32796be614b376e488aa38bda0c22edffe Mon Sep 17 00:00:00 2001 From: Ullaakut Date: Sat, 29 Jun 2019 10:01:59 +0200 Subject: [PATCH] Restructure documentation --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e8c1a2c..7f4b89f 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@

-Astronomer is a tool to fetch data from every GitHub user who starred a common repository and compute how likely it is that those users are real humans. -The goal of this tool is to **detect illegitimate GitHub stars from bot accounts**, which could be used to artificially increase the popularity of an open source project. +Astronomer is a tool that fetches data from every GitHub user who starred a common repository and computes how likely it is that those users are real humans. +The goal of Astronomer is to **detect illegitimate GitHub stars from bot accounts**, which could be used to artificially increase the popularity of an open source project. ## Trust algorithm @@ -35,22 +35,6 @@ Trust is computed based on many different factors: * The average weighted contribution score (weighted by making older contributions more trustworthy) * The average account age, older is more trustworthy -### Upcoming improvements - -I am planning on soon also computing every 5th percentile (`5`, `10`, `15` and so on) and try to detect any irregularity. This would mean that if at least 5% of the total stars are fake, they should result in an anomaly in at least one of those percentile values. It will be difficult to make this a precise estimation however, so it will not be available in the first version of Astronomer. - -## Examples - -

- -

-

- -

-

- -

- ## How to use it ### Docker image @@ -80,6 +64,27 @@ The `astronomer` binary will then be available in `$GOPATH/bin/astronomer`. * **`-d, --debug`**: Show more detailed trust factors, such as percentiles (default: false) * **`-c, --cachedir` (string)**: Set the directory in which to store cache data (default: `./data`) +## Upcoming features + +In the future, Astronomer will hopefully: + +* Generate GitHub badges to show off that your repository is legit (thanks [@emilevauge](https://github.com/emilevauge) for the idea!) +* Provide a web interface to request scans and get your badge + +Keep in mind that scans are always going to be long for huge repositories. A 10K+ stars repository will take multiple hours to scan. + +## Examples + +

+ +

+

+ +

+

+ +

+ ## Questions & Answers > _How accurate is this algorithm? Why does my repository has a low trust level?_