Browse Source

Some general fixes and updates on README file

pull/2/head
Artur Arseniev 11 years ago
parent
commit
3b2c3e40b5
  1. 78
      README.md

78
README.md

@ -1,33 +1,83 @@
# Grapes # GrapesJS
Grapes is a free and open source WTE (Web Template Editor) for building HTML templates to be used inside sites, webapps, newsletters or anything else. GrapesJS is a free and open source Web Template Editor for building HTML templates to be used inside sites, webapps, newsletters or anything else related with HTML.
Be aware that is not a 'Website Builder' but a tool to create HTML structure and containers for contents. The great thing about Grapes is that you Be aware that is not a 'Website Builder' but a tool to create HTML structure and containers for contents. The great thing about Grapes is that you can customize it, extend it or even integrate with other applications.
can customize it, extend it or even integrate with other applications.
<Image> <Image>
### Install as stand-alone ### Features (configurable)
* Style Manager, for component styling
<image>
* Layer Manager, that comes handy with nested elements
<image>
* Code exporter
<image>
* Asset Manager, for uploading and managing images
<image>
* Local and remote storage
* Default built-in commands (basically for creating and managing different components)
### Installation
Download GrapesJS from npm `npm install grapesjs` or bower `bower install grapesjs`
### Development
GrapesJS uses [RequireJS](http://requirejs.org/) to organize its files
Install dependencies.
```sh ```sh
$ npm install $ npm install
``` ```
Build with [Grunt](http://gruntjs.com/)
```sh
$ grunt build
```
Launch server, which also gonna watch some files, and try out the demo on `localhost:9000/index.html`
```sh
$ grunt dev --port 9000
```
Tests are already available inside browser on `localhost:9000/test/index.html`
### Usage ### Usage
### Configuration
### API ### API
cooming soon - Slate
Documentation cooming soon
### Testing ### Testing
Tests are run by [PhantomJS](http://phantomjs.org/) using [Mocha](https://mochajs.org/) (with [Chai](http://chaijs.com/) and [Sinon](http://sinonjs.org/) help)
```sh
$ grunt test
```
### Contributing ### Contributing
usual pull request Usual pull request
### How do I get set up? ### ## License
* Summary of set up BSD 3-clause
* Configuration
* Dependencies
* Database configuration
* How to run tests
* Deployment instructions
Loading…
Cancel
Save