Skip to content

Commit e997c58

Browse files
committed
First README documentation
1 parent 4a4bc12 commit e997c58

File tree

1 file changed

+84
-2
lines changed

1 file changed

+84
-2
lines changed

README.md

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,88 @@
11
ArteJS [![Build Status](https://secure.travis-ci.org/vistaprint/ArteJS.png?branch=master)](http://travis-ci.org/vistaprint/ArteJS)
22
======
33

4-
ArteJS is a powerful, extensible, configurable, flexible and cross-browser rich text editor with a simple API that produces consistent, valid and concise html.
4+
[ArteJS](http://vistaprint.github.io/ArteJS/ "ArteJS Examples / Documentation") is a powerful, extensible, configurable, flexible and cross-browser rich text editor with a simple API that produces consistent, valid and concise html.
55

6-
[ArteJS Examples / Documentation](http://vistaprint.github.io/ArteJS/ "ArteJS Examples / Documentation")
6+
## Development
7+
8+
The development of this project requires [git](http://www.git-scm.com/), [NodeJS](http://nodejs.org/) or [iojs](https://iojs.org/en/index.html), and [Grunt](http://gruntjs.com/) to be installed.
9+
10+
To install Grunt:
11+
12+
```sh
13+
npm install -g grunt-cli
14+
```
15+
16+
You might wanna clone this project:
17+
18+
```sh
19+
git clone [email protected]:vistaprint/ArteJS.git
20+
cd ArteJS
21+
```
22+
23+
And install its dependencies:
24+
25+
26+
```
27+
npm install
28+
```
29+
30+
### Building and Testing
31+
32+
To build and check everything, just run:
33+
34+
```
35+
grunt
36+
```
37+
38+
Grunt will run checking and build tasks. This will also run the basic unit tests. To run all the tests on this project, you need to run:
39+
40+
```sh
41+
grunt qunit:all
42+
```
43+
44+
Or open `tests/all.html` in a browser.
45+
46+
### Branches and commits
47+
48+
For everything you change, please create a new branch before commiting, you can also reference an existing issue by prefixing it's number:
49+
50+
```sh
51+
git checkout -b 17-fix-unit-tests
52+
```
53+
54+
Remember to not commit directly into the master branch.
55+
56+
If some commit fixes or references an issue, say it into the commit message, e.g.:
57+
58+
```
59+
Implement the unit tests
60+
61+
Fixes #17
62+
```
63+
64+
## API
65+
66+
To use ArteJS in your project, you need to bring load in your page:
67+
68+
- jQuery 1.7.3 up to 1.9.1 (1.10+ support is current in progress).
69+
- `dist/rangy.js`
70+
- or `dist/arte.js` or the minified version `dist/arte.min.js`
71+
72+
Example:
73+
74+
```html
75+
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
76+
<script src="dist/rangy.js"></script>
77+
<script src="dist/arte.min.js"></script>
78+
```
79+
80+
Then, you just call it in your JS:
81+
82+
```js
83+
jQuery(function($) {
84+
var arte = $('#my-editor').Arte();
85+
});
86+
```
87+
88+
For more examples and further documentation, checkout our [home page](http://vistaprint.github.io/ArteJS/ "ArteJS Examples / Documentation").

0 commit comments

Comments
 (0)