Skip to content
This repository has been archived by the owner on Feb 3, 2022. It is now read-only.

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pawelad committed Oct 29, 2017
1 parent abbb791 commit df44bf8
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
@@ -1,20 +1,25 @@
# Zenboard
<p align="center">
<img src="https://cdn.rawgit.com/pawelad/zenboard/abbb7917/src/zenboard/static/img/logo.png" alt="Verse logo">
</p>

[![Build status](https://img.shields.io/travis/pawelad/zenboard.svg)][travis]
[![GitHub release](https://img.shields.io/github/release/pawelad/zenboard.svg)][github]
[![Test coverage](https://img.shields.io/coveralls/pawelad/zenboard.svg)][coveralls]
[![License](https://img.shields.io/github/license/pawelad/zenboard.svg)][license]

Zenboard is a straightforward Django application that gives you the ability to
create read only [ZenHub][zenhub] boards that you can share with other people
without the need to give them access to your GitHub repository.
without giving them access to your GitHub repository. It also makes it possible
to filter the board and issue content.

Based on proof of concept by @kuuji - https://github.com/kuuji/dashub
Based on proof of concept by [@kuuji][kuuji] - [kuuji/dashub][kuuji dashub]

Very much a work in progress.
Usable at the moment, but very much a work in progress.

## Running it locally
Take a look [here][running locally] if you want to run Zenboard locally and
feel free to [open an issue][zenboard new issue] if you'r having any problems.
## Running it
Take a look [here][running locally] if you want to run Zenboard yourself,
either locally or in production, and [open an issue][zenboard new issue] if
you're having any problems.

## Contributions
Feel free to use, ask, fork, star, report bugs, fix them, suggest enhancements,
Expand All @@ -30,8 +35,8 @@ To run tests yourself you need to set environment variable with Django secret
key before running `tox` inside the repository:

```shell
$ export SECRET_KEY='...'
$ pip install tox
$ export SECRET_KEY='...'
$ tox
```

Expand All @@ -43,9 +48,11 @@ Released under [Apache License 2.0][license].

[coveralls]: https://coveralls.io/github/pawelad/zenboard
[github]: https://github.com/pawelad/zenboard
[kuuji]: https://github.com/kuuji
[kuuji dashub]: https://github.com/kuuji/dashub
[license]: https://github.com/pawelad/zenboard/blob/master/LICENSE
[pawelad]: https://github.com/pawelad
[running locally]: https://github.com/pawelad/zenboard/wiki/Running-Zenboard-locally
[running locally]: https://github.com/pawelad/zenboard/wiki/Running-Zenboard
[travis]: https://travis-ci.org/pawelad/zenboard
[zenboard new issue]: https://github.com/pawelad/zenboard/issues/new
[zenhub]: https://www.zenhub.com/

0 comments on commit df44bf8

Please sign in to comment.