Skip to content

Commit

Permalink
Cleaned up README
Browse files Browse the repository at this point in the history
  • Loading branch information
leo authored Nov 28, 2016
1 parent 20ae6d3 commit a2072e7
Showing 1 changed file with 13 additions and 27 deletions.
40 changes: 13 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# slackin
![](https://github.com/zeit/art/blob/26e8d259270738f6282037f7a8f5850cc55db296/slackin/repo-banner.png)

A little server that enables public access to a Slack server. Like freenode, but on Slack.

It provides
## Features

- A landing page you can point users to fill in their
emails and receive an invite (`https://slack.yourdomain.com`)
@@ -13,30 +11,22 @@ It provides

Read more about the [motivations and history](http://rauchg.com/slackin) behind Slackin.

## How to use

### Server

#### Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/rauchg/slackin/tree/master)

#### Azure

[![Deploy to Azure](http://azuredeploy.net/deploybutton.svg)](https://azuredeploy.net/)
## Usage

#### OpenShift
Install [Now.app](https://zeit.co/app), setup the Now CLI and run this:

[Follow these instructions.](https://github.com/rauchg/slackin/wiki/OpenShift)

#### Cloud Foundry
```bash
$ now -e SLACK_API_TOKEN="<token>" -e SLACK_SUBDOMAIN="<team-name>" rauchg/slackin
```

##### IBM Bluemix
[![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/rauchg/slackin)
Other platforms:

For other CloudFoundry providers, [follow these instructions.](https://github.com/pivotal-cf/slackin/wiki/Cloud-Foundry)
- [Heroku](https://heroku.com/deploy?template=https://github.com/rauchg/slackin/tree/master)
- [Azure](https://azuredeploy.net/)
- [OpenShift](https://github.com/rauchg/slackin/wiki/OpenShift)
- [IBM Bluemix](https://bluemix.net/deploy?repository=https://github.com/rauchg/slackin)

#### NPM
### The Command

Install it and launch it on your server:

@@ -163,7 +153,3 @@ files in lib/ to update the versions in node/.
excellent [shields](https://github.com/badges/shields) project.
- The button CSS is based on
[github-buttons](https://github.com/mdo/github-buttons).

## License

MIT

0 comments on commit a2072e7

Please sign in to comment.