Skip to content

Commit

Permalink
Improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
raffij committed Jul 11, 2016
1 parent d460200 commit a6c8ea6
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 10 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
@@ -1,5 +1,11 @@
# Changelog

## 0.6.x

### 0.6.0

* New interface

## 0.5.x

### 0.5.0
Expand Down
7 changes: 6 additions & 1 deletion Readme.md
Expand Up @@ -13,10 +13,14 @@ Conceived by [Andrew Sprinz](http://github.com/andrewsprinz). Maintained by [Chr

### Quick start

The recomended way to install Sir Trevor in your project is using npm. This will install all the files required in the `build` directory for the module.

```
npm install sir-trevor
```

Note: Sir Trevor is distributed combined with it's dependencies. If you wish to modify Sir Trevor you will want to clone the repository and use the [Compiling instructions](#compiling) below.

HTML

```html
Expand Down Expand Up @@ -120,10 +124,11 @@ matrix:
- BROWSER_NAME='firefox' BROWSER_VERSION='46' PLATFORM='OSX 10.10'
- BROWSER_NAME='firefox' BROWSER_VERSION='46' PLATFORM='Windows 7'

## Build docs
## Building gh-pages docs

```
cd website
bower install
bundle exec rake publish PROJECT_ROOT=./ ALLOW_DIRTY=true
```

Expand Down
25 changes: 16 additions & 9 deletions website/source/partials/docs/_1.html.markdown
Expand Up @@ -8,7 +8,19 @@ Sir Trevor provides a means to transform a text input into a rich content editor
<a name="1-1"></a>
## Installation

The easier way to install Sir Trevor is with [Bower](https://github.com/bower/bower), the front-end package manager from Twitter. If you do use Bower, your `bower.json` file should look something like this:
### npm

[npm](https://github.com/npm/npm) package

```
npm install --save sir-trevor
```

### Bower

[Bower](https://github.com/bower/bower) package.

Your `bower.json` file should look something like this:

```js
{
Expand All @@ -21,15 +33,8 @@ The easier way to install Sir Trevor is with [Bower](https://github.com/bower/bo

Then run `bower install` on your project to install the necessary dependencies.

We also provide an [npm](https://github.com/npm/npm) package

```
npm install sir-trevor
```

Alternatively, grab the following files and include them in your project:

* [Eventable](https://github.com/madebymany/eventable/blob/master/eventable.js)
* [Sir Trevor JS](https://github.com/madebymany/sir-trevor-js/blob/dist/build/sir-trevor.js)

You'll need the following CSS file too:
Expand All @@ -38,7 +43,7 @@ You'll need the following CSS file too:

And the icons file:

* [Sir Trevor Icons](https://github.com/madebymany/sir-trevor-js/blob/dist/build/sir-trevor-icons.svg) [Configure icon url](#1-5)
* [Sir Trevor Icons](https://github.com/madebymany/sir-trevor-js/blob/dist/build/sir-trevor-icons.svg)

<a name="1-2"></a>
## Initialising
Expand All @@ -63,6 +68,8 @@ Then to transform this element to a Sir Trevor instance:
</script>
```

You'll also need to [configure icon url](#1-5)

<a name="1-3"></a>
## The Output

Expand Down

0 comments on commit a6c8ea6

Please sign in to comment.