Skip to content

Commit

Permalink
Change the headings to look better on the githoobs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanramage committed Sep 14, 2012
1 parent a61b816 commit 19dfd88
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Expand Up @@ -17,11 +17,11 @@ balanced for speed, flexibilty and ease of use. Here are some choices made:



# Getting started
## Getting started

First off you will need a few things, you will need ```node``` and ```npm``` installed.

## Install kanso
### Install kanso

[Kanso](http://kan.so) is the main tool for working with couchdb. It has great packages and provided the interface to the market.

Expand All @@ -30,7 +30,7 @@ First off you will need a few things, you will need ```node``` and ```npm``` ins
npm install -g kanso
```

## Install Jam
### Install Jam

[Jam](http://jamjs.org/) will be used to manage the frontend dependencies. You actually might not need jam, because the dependencies
are already in this repo. But if you want to add new dependencies, please use jam. Its fine to use other package managers as well. We just
Expand All @@ -40,12 +40,12 @@ dont have time to show how to do so.
npm install -g jamjs
```

## Install A Garden or CouchDB
### Install A Garden or CouchDB

Follow the instructions [here](http://garden20.com/get) to get a garden for yourself.


## Push it
### Push it

You should now be ready to push this app to your garden. Try this:

Expand Down Expand Up @@ -77,11 +77,11 @@ kanso push http://127.0.0.1:5984/baseline --minify



# Your Changes
## Make it your own

Now that you have can push the app to your garden, you probably want to do your own work on it. Here are some things to do:

## Edit kanso.json
### Edit kanso.json

- Change the "name" property is probably the single most important thing to change off the bat. There is no namespacing and it should be globally unique so check that the name is not taken.
- Change the url to your github repo location
Expand All @@ -94,7 +94,7 @@ At this point, please dont alter anything else.



## Make an app!
### Make an app!

The places you will most likely be editing are the following files:

Expand All @@ -104,13 +104,13 @@ The places you will most likely be editing are the following files:
- ```couch/ddoc.js``` which is a couchdb design document.


## Promotional Stuff
### Promotional Stuff

After your app is all polished off, take some time to make some screenshots, icons, a favicon, and promotional images. Overwrite all the placeholder images in the ```img/promo``` folder



# Push To The Development market
## Push To The Development market

You should push to a development market before you push to the main market. This will allow you to test installing your app before others see it.

Expand All @@ -123,7 +123,7 @@ kanso push https://garden.iriscouch.com/garden/_design/garden/_rewrite/upload --
```


# Push your app to the Garden Market
## Push your app to the Garden Market

Create an account, if you have not done so, at http://garden20.com/account

Expand All @@ -133,7 +133,7 @@ Then push your app
kanso push http://garden20.com/market/upload --minify
```

# FAQ
## FAQ

### I have added a file or folder off the root directory and it is not getting uploaded?

Expand Down Expand Up @@ -183,7 +183,7 @@ You can find available packages here: [jamjs.org](http://jamjs.org/packages#/)

If you dont find your cooljs library just bug someone on #jamjs and they will probably help you add it.

### Only users and admins be able to change things in the db
### Only users and admins are able to change things in the db

We turned this on by default so you will be aware of where to handle read security. Alter ```couch/ddoc.js``` and modify the validate_doc_update function.

Expand Down

0 comments on commit 19dfd88

Please sign in to comment.