jonathan/hostr
jonathan/hostr
1
0
Fork 0
Code Issues Pull requests 4 Projects Releases Packages 1 Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Jonathan Cremin 2016-06-02 21:24:31 +01:00
parent 24e42343e4
commit a1a39778aa
1 changed files with 3 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -7,13 +7,9 @@ It has been through many iterations, but in its current incarnation Hostr uses [
## Getting Started
### Runtimes
Currently tested and runs on iojs 2.5.0, probably works on earlier releases and on node. Does yet not work on iojs > 3 due to the NAN changes introduced.
### Dependencies
You'll need `graphicsmagick` for image thumbnailing, everything else is taken care of by an `npm install`.
Everything is taken care of by an `npm install`.
### Enviroment Variable Configuration
@ -21,9 +17,7 @@ See [`.env.example`](.env.example). Copy it to `.env`, modify and `source .env`
### Deploying to Heroku
Because it uses iojs and graphicsmagick runtimes hostr needs an env variable for `BUILDPACK_URL` set to `https://github.com/ddollar/heroku-buildpack-multi.git` on Heroku.
You'll also need to add Heroku Redis and a MongoDB addon.
You'll need to add Heroku Redis and a MongoDB addon.
## Usage
@ -53,4 +47,4 @@ Running the tests will also set the indexes required for Mongo.
## Licence
My primary motivation is to get to work on Hostr in public. Contributions are welcome and all Javascript is MIT licenced, however the brand is not. The brand includes the name, logo images, CSS and marketing HTML.
My primary motivation is to get to work on Hostr in public. Contributions are welcome and all Javascript is Apache licenced, however the brand is not. The brand includes the name, logo images, CSS and marketing HTML.