version 0.2.0

README.md

@@ -1,29 +1,48 @@
-# romajs
+# RomaJS
 
 [![Build Status](https://travis-ci.org/TEIC/romajs.svg?branch=dev)](https://travis-ci.org/TEIC/romajs)
 
-## **WORK IN PROGRESS**
+RomaJS is a web app for creating and editing ODD documents to customize and generate schemata for the [Text Encoding Initiative](http://www.tei-c.org/).
 
-A rewrite of TEI Roma in JavaScript Redux / React.
+This web app is written in React/Redux and is designed to be easily compiled and deployed as a static site. Some key transformations are handled online via the API provide by [OxGarage](https://wiki.tei-c.org/index.php/OxGarage), a TEI maintained online service. TEI data comes from the [TEI Vault](www.tei-c.org/Vault/).
 
-## Install
+## How to deploy
+
+Download the latest build from the [release page](https://github.com/TEIC/romajs/releases). Serve the static site from a simple server. You will need to set up a rewrite to index.html to make sure URL routes will work. For example in Apache 2:
+
+```
+RewriteEngine On
+
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ index.html [L,QSA]
+```
+
+You can also deploy it via [Docker](https://hub.docker.com/r/teic/romajs).
+
+## How to develp
+
+Make sure node.js is installed then:
 
 ```
 $ npm install
 ```
 
-## Test
+### Test
 
 ```
 $ npm test
 ```
 
-## Serve locally (for development)
+### Serve locally for development
 ```
 $ npm start
 ```
 
-## Build static assets (for now)
+### Build static assets
 ```
 $ npm run build
 ```
+
+### Change URL to OxGarage service
+
+Edit `src/utils/oxgarage.js` and rebuild.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "romajs",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Javascript implementation of Roma in React-Redux",
   "main": "index.js",
   "scripts": {

src/utils/version.js

@@ -1,2 +1,2 @@
 // RomaJS version
-export default '0.1.0'
+export default '0.2.0'