Skip to content

Commit a8529ad

Browse files
authored
docs: edit README
1 parent ddfed15 commit a8529ad

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# just-dashboard [![Travis](https://img.shields.io/travis/kantord/just-dashboard/master.svg)]() ![Codecov](https://img.shields.io/codecov/c/github/kantord/just-dashboard/master.svg)
1+
<h1 align="center">just-dashboard</h1>
22

3-
[![Join the chat at https://gitter.im/just-dashboard/Lobby](https://badges.gitter.im/just-dashboard/Lobby.svg)](https://gitter.im/just-dashboard/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
43

5-
[Website](https://kantord.github.io/just-dashboard/)
4+
<p align="center">
5+
<a href="https://kantord.github.io/just-dashboard/">Documentation</a> •
6+
<a href="https://kantord.github.io/just-dashboard/getting-started">Getting started</a> •
7+
<a href="https://kantord.github.io/just-dashboard/components.html">Chart types</a>
8+
</p>
69

7-
just-dashboard let's you turn this:
10+
[![Travis](https://img.shields.io/travis/kantord/just-dashboard/master.svg)]() ![Codecov](https://img.shields.io/codecov/c/github/kantord/just-dashboard/master.svg)
11+
12+
just-dashboard turns this:
813
```yaml
914
dashboard "Food":
1015
- h1 text: Food
@@ -44,10 +49,3 @@ To host your dashboard, you can roll your own backend, or:
4449

4550
In fact, I've created a Gist with the example above: [https://gist.github.com/kantord/2973bdd4ad689642562018bb4091ffbd](https://gist.github.com/kantord/2973bdd4ad689642562018bb4091ffbd);
4651
thus it's accessible as a dashboard at: [http://bottoml.in/e/kantord/2973bdd4ad689642562018bb4091ffbd](http://bottoml.in/e/kantord/2973bdd4ad689642562018bb4091ffbd)
47-
48-
49-
## Documentation
50-
Documentation is available at: [https://kantord.github.io/just-dashboard/](https://kantord.github.io/just-dashboard/)
51-
52-
## License
53-
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkantord%2Fjust-dashboard.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkantord%2Fjust-dashboard?ref=badge_large)

0 commit comments

Comments
 (0)