Skip to content

Commit

Permalink
Flesh out readme
Browse files Browse the repository at this point in the history
Now with information on our mailing list, contribution guidelines!
  • Loading branch information
rrix committed Aug 30, 2012
1 parent ae09f24 commit 12d8666
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,35 @@ SpaceApi

Canonical repository for the SpaceState API.

Branches
--------

There are two primary branches: master and devel

``master'' is the "gold standard current API", the current stable API which spaces
should implement.

``devel'' is the experimental branch where features and fixes are accrued
between releases.

Extending the API
-----------------

API extensions are welcome and encouraged! If you would like to propose an API
extension, please contact our [mailing list on the hackerspaces.org
mailman](http://lists.hackerspaces.org/mailman/listinfo/spaceapi-devel) so
that we can discuss your changes. When you are ready to integrate them, please
open a pull request pointed towards the devel branch.

Adding your space to the directory
----------------------------------

Edit ``spacestatusdirectory.php'' and add your space to the large list of spaces:

```php
'TechInc' => 'https://techinc.nl/space/spacestate.json',
```

Commit this with a message along the lines of "Add FOOLABS to Space Directory"
and pull request against the master branch.

0 comments on commit 12d8666

Please sign in to comment.