Skip to content

Commit

Permalink
Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
veelenga committed Jul 12, 2017
1 parent d0e3842 commit 8067a5a
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
# Crystal [ANN]

Announce your new project, blog post, version update or other Crystal work.
Source code for https://crystal-ann.com.

## Installation
## Setup

Create a pg database called `crystal_ann` and configure the `config/database.yml`
to provide the credentials to access the table.

Then:
```
shards update
amber migrate up
crystal db/seed.cr
$ shards update
$ amber migrate up
$ crystal db/seed.cr
```

## Usage
## Run

To run the demo:
```
crystal build src/crystal-ann.cr
./crystal-ann
$ amber watch
```

## Contributing
## Deployment

1. Fork it ( https://github.com/veelenga/crystal-ann/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
```
$ heroku create app-name --buildpack https://github.com/crystal-lang/heroku-buildpack-crystal.git
$ heroku config:set GITHUB_ID=github_client_id
$ heroku config:set GITHUB_SECRET=github_client_secret
$ git push heroku master
```

0 comments on commit 8067a5a

Please sign in to comment.