@ -27,12 +29,12 @@ Try it here: http://grapesjs.com/demo.html
* Default built-in commands (basically for creating and managing different components)
### Installation
## Installation
You can get GrapesJS with `bower install grapesjs` or via `git clone https://github.com/artf/grapesjs.git` to directly use it. For development purpose you should follow instructions below.
### Development
## Development
GrapesJS uses [RequireJS](http://requirejs.org/) to organize its files inside `src` folder and [Grunt](http://gruntjs.com/) for build them to `dist`
@ -67,7 +69,8 @@ Tests are already available inside browser on `localhost:8000/test`
If [Grunt](http://gruntjs.com/) is already installed globally you could change the port by using `grunt dev --port 9000`
### Usage
## Usage
JQuery is the only hard dependency so you have to include it before use GrapesJS.
```html
@ -92,7 +95,7 @@ Unfortunately with the configuration above you wouldn't see a lot. This because
The section below will explain some basic configurations but for a more practical example I suggest to look up the code inside this demo: http://grapesjs.com/demo.html
### Configuration
## Configuration
For now I only show up some general settings, for more details check source or demo. Examples will be available soon
@ -142,12 +145,12 @@ var config = {
```
### API
## API
At the moment `render()` is the only available method but others will be public very soon...
### Testing
## Testing
**ATTENTION: tests are pretty far away from being complete**
@ -157,7 +160,7 @@ Tests are run by [PhantomJS](http://phantomjs.org/) using [Mocha](https://mochaj
$ npm run test
```
### Acknowledgements
## Acknowledgements
GrapesJS is built on top of this amazing open source projects:
@ -169,7 +172,7 @@ GrapesJS is built on top of this amazing open source projects:
* [FontAwesome] - the iconic font and CSS framework
### Contributing
## Contributing
Any kind of help is welcome. At the moment there is no generic guidelines so use usual pull requests and push to `dev` branch