Skip to content

Commit 9acccb2

Browse files
authored
[feat] Added a 'what is it?' section to README. (#93)
1 parent 0ffa58e commit 9acccb2

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,31 @@
77
</h1>
88

99
<h3 align="center">
10-
Sourcerer app creates an intelligent profile for software engineers.<br/>
11-
Get early access on <a href="https://sourcerer.io">Sourcerer</a>.
10+
Sourcerer app creates an intelligent profile for software engineers
1211
</h3>
1312
<br>
1413

14+
What is it?
15+
===========
16+
17+
Once you feed it some git repos, you will get a beautiful profile that will help
18+
you learn things about yourself, connect to others, and become a better
19+
engineer. Example profiles: <https://sourcerer.io/sergey>,
20+
<https://sourcerer.io/frankie>, <https://sourcerer.io/ice1snice>.
21+
22+
Profile is the first step. Some of the things on our roadmap:
23+
news that is relevant to your code, engineers to follow and learn from,
24+
technology and libraries you should know about, projects
25+
that could use your help.
26+
27+
Both open source and closed source repos are fine. Sourcerer app does not upload
28+
source code anywhere, and it never will. The app looks at repos locally on your
29+
machine, and then sends stats to sourcerer.io. The best way to verify is to
30+
look at the code. [src/main/proto/sourcerer.proto](https://github.com/sourcerer-io/sourcerer-app/blob/develop/src/main/proto/sourcerer.proto)
31+
is a good start as it describes the client-server protocol.
32+
33+
You will need an account, sign up on <https://sourcerer.io/>
34+
1535
Prerequirements
1636
=================
1737

0 commit comments

Comments
 (0)