Skip to content

Commit

Permalink
Update README with documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
kirubarajan committed Oct 4, 2017
1 parent ace94c9 commit e2edee1
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Penn Central

brrrrrrrrrrrrrrrrr
General documentation for the Penn Central codebase is available [here](https://www.notion.so/Penn-Central-Documentation-d0096d11e9694ea991093937590e7139) and is updated as new features are pushed to the code repository.

## Usage

After a `env.sh` file containing `PORT` and `MONGO_URL` values is created:

`git clone https://github.com/pennlabs/penncentral.git`

`cd penncentral && yarn`

`yarn dev`

React application will be available at `localhost:PORT`.

0 comments on commit e2edee1

Please sign in to comment.