Skip to content

Commit

Permalink
Updated readme insrructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Ehesp committed Nov 1, 2014
1 parent e09339b commit 73e92c5
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Check out a live example!

> This repository provides only the stying needed to implement RDash into your project.
## Current Implementations
## Current Framework Implementations

* with AngularJS: [rdash-angular](https://github.com/rdash/rdash-angular)
* with jQuery: [rdash-jquery](https://github.com/rdash/rdash-jquery)
Expand All @@ -19,24 +19,35 @@ Check out a live example!
* [Gulp](http://bower.io)

### Installation
1. Clone the repository: `git clone https://github.com/rdash/rdash-ui.git`
2. Install the NodeJS depencanies: `sudo npm install`. This should automatically run a `bower install` command.
3. Run the gulp build task: `gulp build`.
4. Run the gulp default task: `gulp`. This will build any changes made automatically, and also run a live reload server on [http://localhost:8080](http://localhost:8080).
rdash-ui is available as a bower project, or available to download youself.

All project distribution files will be located within the `dist` directory.
#### Bower
`bower install rdash-ui`
or include as a project dependancy in your `bower.json`:
```
"dependencies": {
"rdash-ui": "*"
},
```

## Wiki
For full documentation on the dashboard, visit the [Wiki]().

## Contributing
> Do not use the `dist` directory for contributions, please edit the `less` files.
Use the `index.html` to test your changes/features.
1. Clone the repository: `git clone https://github.com/rdash/rdash-ui.git`
2. Install the NodeJS depencanies: `sudo npm install`. This should automatically run a `bower install` command.
3. Run the gulp build task: `gulp build`.
4. Run the gulp default task: `gulp`. This will build any changes made automatically, and also run a live reload server on [http://localhost:8080](http://localhost:8080).

All project distribution files will be located within the `dist` directory. Use the `index.html` to test your changes/features.

### Pull Requests
1. Fork this repository.
2. Create a new branch, with the name of your fix/feature.
3. Send the pull requests into the projects `develop` branch.
### Implementations

### Framework Implementations
TO DO

0 comments on commit 73e92c5

Please sign in to comment.