|
1 |
| - |
2 | 1 | <h1 style="font-weight:normal">
|
3 | 2 | <a href="https://sourcerer.io"><img src=https://user-images.githubusercontent.com/20287615/34189346-d426d4c2-e4ef-11e7-9da4-cc76a1ed111d.png alt="Sourcerer Logo", width=50></a>
|
4 | 3 | sourcerer.io
|
5 | 4 | </h1>
|
6 |
| - A visual profile for software engineers. Start with your public GitHub at <a href="https://sourcerer.io/start">https://sourcerer.io/start</a>. Screenshot below. |
| 5 | +A visual profile for software engineers. |
| 6 | +<br> |
| 7 | + |
| 8 | +Start with your public GitHub at <a href="https://sourcerer.io/start">https://sourcerer.io/start</a>. |
7 | 9 | <br>
|
8 | 10 |
|
9 |
| -What is it? |
10 |
| -=========== |
| 11 | + |
| 12 | +Screenshot |
| 13 | +========== |
11 | 14 |
|
12 | 15 | 
|
13 | 16 | <br>
|
14 | 17 |
|
15 |
| -Once you feed it some git repos, you will get a beautiful profile that will help |
16 |
| -you learn things about yourself, connect to others, and become a better |
17 |
| -engineer. Example profiles: <https://sourcerer.io/sergey>, |
18 |
| -<https://sourcerer.io/ddeveloperr>, <https://sourcerer.io/osantana>, <https://sourcerer.io/adnanrahic>. |
| 18 | +What is it? |
| 19 | +=========== |
| 20 | + |
| 21 | +Once you feed [Sourcerer](https://sourcerer.io/) some git repos, you will get a beautiful profile that will help you learn things about yourself, connect to others, and become a better |
| 22 | +engineer. |
19 | 23 |
|
20 |
| -Profile is the first step. Some of the things on our roadmap: |
21 |
| -news that is relevant to your code, engineers to follow and learn from, |
22 |
| -technology and libraries you should know about, projects |
23 |
| -that could use your help. |
| 24 | +Example profiles:<br> |
| 25 | +<https://sourcerer.io/sergey><br> |
| 26 | +<https://sourcerer.io/ddeveloperr><br> |
| 27 | +<https://sourcerer.io/wanghuaili><br> |
| 28 | +<https://sourcerer.io/adnanrahic><br> |
24 | 29 |
|
25 |
| -Both open source and closed source repos are fine. The easiest way to get started with open source repos is to go to |
26 |
| -<https://sourcerer.io/start>, and select GitHub. For closed source repos, you can |
27 |
| - use this Sourcerer app. You will still need an account, which you can get at <https://sourcerer.io/> |
| 30 | +Both open source and closed source repos are fine. The easiest way to get started is with your open source repos. Go to <https://sourcerer.io/start>, and select *Build with GitHub* and watch your profile build. For closed source repos, you will need to use this app. If you already created an account using GitHub, you would have received an email with credentials for the app. If not, You will need a new account, which you can get at <https://sourcerer.io/start>, and select *Build with app*. |
28 | 31 |
|
29 |
| -Sourcerer app does not upload source code anywhere, and it never will. The app looks at repos locally on your |
30 |
| -machine, and then sends stats to sourcerer.io. The best way to verify is to |
31 |
| -look at the code. [src/main/proto/sourcerer.proto](https://github.com/sourcerer-io/sourcerer-app/blob/develop/src/main/proto/sourcerer.proto) |
| 32 | +The 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) |
32 | 33 | is a good start as it describes the client-server protocol.
|
33 | 34 |
|
34 |
| -You will need an account, sign up on <https://sourcerer.io/> |
| 35 | +Creating your profile is just the first step for us at Sourcerer. Some of the things on our roadmap include: |
| 36 | +* News that is relevant to your code |
| 37 | +* Engineers to follow and learn from |
| 38 | +* Technology and libraries you should know about |
| 39 | +* Projects that could use your help |
| 40 | + |
35 | 41 |
|
36 | 42 | Requirements
|
37 | 43 | ============
|
@@ -75,7 +81,17 @@ $ gradle build -Penv=production
|
75 | 81 | $ java -jar build/libs/sourcerer-app.jar
|
76 | 82 | ```
|
77 | 83 |
|
78 |
| -Contribution |
| 84 | +Contributing |
79 | 85 | ============
|
80 | 86 |
|
81 |
| -We welcome contributions to Sourcerer App by the community. Check the [Contribution guide](https://github.com/sourcerer-io/sourcerer-app/blob/master/CONTRIBUTING.md) for more information. |
| 87 | +We love contributions! Check out the [Contribution guide](https://github.com/sourcerer-io/sourcerer-app/blob/master/CONTRIBUTING.md) for more information. |
| 88 | + |
| 89 | +Some handy links:<br> |
| 90 | +* [Sourcerer Site](https://sourcerer.io/) |
| 91 | +* [Sourcerer Blog](https://blog.sourcerer.io) |
| 92 | +* [Follow Sourcerer on Twitter](https://twitter.com/sourcerer_io) |
| 93 | +* [Follow Sourcerer on Facebook](https://www.facebook.com/sourcerer.io/) |
| 94 | + |
| 95 | +License |
| 96 | +======= |
| 97 | +Sourcerer is under the MIT license. See the [LICENSE](https://github.com/sourcerer-io/sourcerer-app/blob/develop/LICENSE.md) for more information. |
0 commit comments