Skip to content
This repository has been archived by the owner on Jul 11, 2019. It is now read-only.

Commit

Permalink
simplify install, add todos
Browse files Browse the repository at this point in the history
  • Loading branch information
ungoldman committed Apr 30, 2015
1 parent e94b389 commit d256146
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,14 @@ Run this on a server to ensure that there will always be a peer available to con

## Install

1. Use newest io.js and npm ((`>= 1.8.1`, `>= 2.8.3`).
2. Install `electron-prebuilt` & `electron-spawn` globally.
3. Install `peerbot` globally.

```
npm install -g peerbot
```

### Requirements

1. Use newest io.js and npm ((`>= 1.8.1`, `>= 2.8.3`).
2. Install `electron-prebuilt` & `electron-spawn` globally.

## Usage

```
Expand All @@ -48,7 +47,7 @@ $ xvfb-run peerbot

Also you [may need to `apt-get install libgconf-2-4`](https://github.com/atom/electron/issues/1518)

## Build and develop locally
## Build and run peerbot locally

Same requirements as in [Install](#install).

Expand All @@ -60,6 +59,13 @@ npm run rebuild-leveldb
npm start
```

## Todo

* Better command line interface
* usage on `-h`/`--help`
* version on `-v`/`--version`
* better channel specification method

## Contributing

Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
Expand Down

0 comments on commit d256146

Please sign in to comment.