Skip to content

Commit e0a7447

Browse files
Created readme
1 parent ba26ea3 commit e0a7447

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# [APIs.is](http://docs.apis.is) - Documentation
2+
3+
This repository holds documentation for the [APIs.is project](https://github.com/kristjanmik/apis).
4+
5+
Since you're here (and still reading), you probably already know what this is all about, and ready to get down to business, but in order to simplify all our lives check out these few pointers.
6+
7+
## Getting started
8+
9+
First of all, this is running on a pretty simple node server using [jade](http://jade-lang.com/) for templating and [less](http://lesscss.org/) for styles. To get it up and running, simply clone this repo to your local directory, install packages and start the app.
10+
11+
```
12+
$ git clone git://github.com/kristjanmik/apis-docs.git
13+
$ npm install
14+
$ npm start
15+
```
16+
17+
If you prefer to start it up without supervisor, simply use the good old
18+
19+
```
20+
$ node app.js
21+
```
22+
23+
## What files to edit
24+
25+
Assuming you're planning to either update current documentation or adding documentation for a new endpoint, you'll need to know that each endpoint has an individual [jade](http://jade-lang.com/) file within `./app/views/apis/` which is included into `./app/views/home.jade`.
26+
27+
## Adding a new Endpoint
28+
29+
### Step by step
30+
31+
1. View current endpoint docs for structure and layout.
32+
2. Create a new *.jade file within `./app/views/apis/`, preferrably using the same name as the endpoint in question.
33+
3. Include your new file into `./app/views/home.jade`

0 commit comments

Comments
 (0)