Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
* Add top image
* Refer to code.ubyssey.ca for overall documentaion
  • Loading branch information
jumbosushi authored Oct 1, 2018
1 parent 8e79a95 commit 041853c
Showing 1 changed file with 5 additions and 28 deletions.
33 changes: 5 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Dispatch
[![codecov](https://codecov.io/gh/ubyssey/dispatch/branch/develop/graph/badge.svg)](https://codecov.io/gh/ubyssey/dispatch)
[![PyPI](https://img.shields.io/pypi/v/dispatch.svg)](https://pypi.python.org/pypi/dispatch)

![dispatch](https://user-images.githubusercontent.com/9669739/46310500-679caf00-c574-11e8-9b70-d08f9bd03de3.png)

Dispatch is a publishing platform for modern newspapers and digital publications. Created in tandem by student journalists and developers, it aims to make online news more open, more hackable, and of course, more fun.

Made with :heart: by [_The Ubyssey_](https://www.ubyssey.ca/), the University of British Columbia's student newspaper since 1918.
Expand All @@ -16,33 +18,8 @@ pip install dispatch

## Contribute

```bash
# Install Dispatch in Development Mode
git clone https://github.com/ubyssey/dispatch.git
cd dispatch
pip install -e .[dev]
python setup.py develop
```

```bash
# Front-end manager app
cd dispatch/dispatch/static/manager
You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. Follow the guide from [code.ubyssey.ca](https://code.ubyssey.ca/installation/dispatch-setup)

# Install dependencies
yarn setup

# Run Webpack in watch mode
yarn start
```
## License

### Testing

```bash

# Run tests
# make sure your current working directory is ubyssey-dev/dispatch
dispatch-admin test

# Generate coverage report
dispatch-admin coverage
```
GNU General Public License v2.0

0 comments on commit 041853c

Please sign in to comment.