From 97843b9e8e75da024a92d7e70b9b36b2fcf598a9 Mon Sep 17 00:00:00 2001 From: Sergey Surkov Date: Thu, 7 Dec 2017 17:40:46 -0800 Subject: [PATCH] [feat] Added a 'what is it?' section to README. --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ace7bdb..a8804595 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,31 @@

- Sourcerer app creates an intelligent profile for software engineers.
- Get early access on Sourcerer. + Sourcerer app creates an intelligent profile for software engineers


+What is it? +=========== + +Once you feed it some git repos, you will get a beautiful profile that will help +you learn things about yourself, connect to others, and become a better +engineer. Example profiles: , +, . + +Profile is the first step. Some of the things on our roadmap: +news that is relevant to your code, engineers to follow and learn from, +technology and libraries you should know about, projects +that could use your help. + +Both open source and closed source repos are fine. Sourcerer app does not upload +source code anywhere, and it never will. The app looks at repos locally on your +machine, and then sends stats to sourcerer.io. The best way to verify is to +look at the code. [src/main/proto/sourcerer.proto](https://github.com/sourcerer-io/sourcerer-app/blob/develop/src/main/proto/sourcerer.proto) +is a good start as it describes the client-server protocol. + +You will need an account, sign up on + Prerequirements =================