Skip to content

Commit 1b6ca4a

Browse files
committed
Update README
1 parent 8e1ae28 commit 1b6ca4a

File tree

1 file changed

+6
-32
lines changed

1 file changed

+6
-32
lines changed

README.md

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,12 @@
1-
2-
[![Build Status](https://travis-ci.org/ember-learn/ember-cli-addon-docs.svg)](https://travis-ci.org/ember-learn/ember-cli-addon-docs)
3-
41
# Ember CLI Addon Docs
52

6-
**NOTE: This is a work in progress but we are quickly moving to a minimal usable set of tools.**
7-
8-
This addon has the goal of providing tools for addon developers to easily document and market their addons.
9-
10-
Features planned:
11-
12-
* [ ] Marketing homepage
13-
* [ ] Versioned API documentation
14-
* [ ] Versioned guides
15-
16-
## Installation
17-
18-
* `git clone <repository-url>` this repository
19-
* `cd ember-cli-addon-docs`
20-
* `npm install`
21-
* `bower install`
22-
23-
## Running
24-
25-
* `ember serve`
26-
* Visit your app at [http://localhost:4200](http://localhost:4200).
27-
28-
## Running Tests
3+
[![npm version](https://img.shields.io/npm/v/ember-cli-addon-docs.svg?style=flat-square)](http://badge.fury.io/js/ember-cli-addon-docs)
4+
[![Build Status](https://img.shields.io/travis/ember-learn/ember-cli-addon-docs.svg?style=flat-square)](https://travis-ci.org/ember-learn/ember-cli-addon-docs)
295

30-
* `npm test` (Runs `ember try:each` to test your addon against multiple Ember versions)
31-
* `ember test`
32-
* `ember test --server`
6+
Easy documentation for Ember addons.
337

34-
## Building
8+
[View the docs here](https://ember-learn.github.io/ember-cli-addon-docs/).
359

36-
* `ember build`
10+
## About
3711

38-
For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).
12+
This library was started by [Dan Freeman](https://twitter.com/schiefgelaufen) and [Sam Selikoff](https://twitter.com/samselikoff). Thanks to all of our [contributors](https://github.com/ember-learn/ember-cli-addon-docs/graphs/contributors)!

0 commit comments

Comments
 (0)