Skip to content

chore: update readme #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 14, 2017
Merged

chore: update readme #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd2a812
feat: update readme
astansler Oct 14, 2017
fdc24c4
chore: remove comma
astansler Oct 14, 2017
4c2cb1e
chore: fix readme
astansler Oct 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
# sourcerer-app
Sourcerer hashes your git repos into intelligent engineering profiles.
<h1 align="center">
<br>
<a href="https://sourcerer.io"><img src="https://user-images.githubusercontent.com/29913247/31576516-0ce3e9ae-b105-11e7-9a8b-89f96bd44a3d.png" alt="Sourcerer" width="200"></a>
<br>
Sourcerer App
<br>
</h1>

<h3 align="center">
Sourcerer app creates an intelligent profile for software engineers.<br/>
Get early access on <a href="https://sourcerer.io">Sourcerer</a>.
</h3>
<br>

Prerequirements
=================

* Sourcerer alpha/beta access
* Linux or macOS
* Java Platform ([JRE](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) for Linux or [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) for macOS)

Install/uninstall
=================

Sourcerer requires Java Platform installed on the system.
* Proceed with JRE(http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) if on Linux,
* or with JDK(http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) if on OS X.

To install sourcerer run the following command:

```
Expand All @@ -33,7 +47,7 @@ $ git clone https://github.com/sourcerer-io/sourcerer-app.git
$ cd sourcerer-app

# Build
$ gradle build
$ gradle build -Penv=production

# Run the app
$ java -jar build/libs/sourcerer-app.jar
Expand Down