Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pixeldesu committed Sep 19, 2016
1 parent 9a3e437 commit f767584
Showing 1 changed file with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,38 @@
</p>

## Usage
Currently Surfbird is not really usable. It has authentication and basic storage logic,
but settings are not saved and several things are unoptimized and uncached.
To use Surfbird, either download one of the [pre-built releases](https://github.com/surfbirdapp/surfbird/releases) or build the client yourself using
the instructions provided below.

**Note:** Surfbird is in no way feature-complete and might be broken for some users. Current provided
releases are for testing purposes!

## Development

### Requirements

* node.js (latest stable should work)
* [Twitter App Tokens](https://apps.twitter.com) with following settings:
* Permissions: _Read, Write and Access direct messages_
* Sign in with Twitter: _No_

### Getting the Source

First, clone the repository using following command:

```
git clone --recursive [email protected]:surfbirdapp/surfbird.git
```

Alternatively, if you already cloned the repository, you can just run:

```
git submodule init
git submodule update
```

This is to get all required submodules, currently only consisting of the [client assets](https://github.com/surfbirdapp/board),
which you need for the client to properly display stuff, or even display anything.

### Preparations

Expand All @@ -37,6 +61,27 @@ Surfbird is following the [Javascript Standard Styleguide](https://github.com/fe

[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

## Contributing

### Bug Reporting / Feature Requests

You are always free to report bugs or request new features with opening an issue on the [issue tracker](https://github.com/surfbirdapp/surfbird/issues),
but please do yourself and the team the favor of searching for your bug/request before opening another
issue for something that might already exist!

### Pull Requests

Want to add a new feature yourself? That's awesome!

You are always free to contribute new features to Surfbird, the most important thing being that you keep
the projects structure intact (or if you have a better solution, open an issue and let us discuss!) and also
adhere to Javascript Standard style.

You can easily check this with running `npm run lint` and you'll get all style errors printed out for you! If
there are nits you can't really fix that easily, leave them be and just mention that in your Pull Request!

Other than that you are perfectly ready to submit your PR, have fun contributing!

## License

Surfbird is licensed under the MIT License

0 comments on commit f767584

Please sign in to comment.