Skip to content

Commit

Permalink
chore: Update README.md (#237)
Browse files Browse the repository at this point in the history
  • Loading branch information
amaury1093 authored Oct 2, 2019
1 parent 44d708c commit 9e86a1f
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Know how many cigarettes you smoke based on the pollution of your location. :poo
![GitHub](https://img.shields.io/github/license/amaurymartiny/shoot-i-smoke.svg)
[![David](https://img.shields.io/david/amaurymartiny/shoot-i-smoke.svg)](https://david-dm.org/amaurymartiny/shoot-i-smoke)
[![](https://img.shields.io/badge/Buy%20me%20a%20tree-%F0%9F%8C%B3-lightgreen)](https://offset.earth/amaurymartiny)
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/shootismoke)

[![app-store](https://shootismoke.github.io/assets/images/app-store.png)](https://itunes.apple.com/us/app/s-i-smoke/id1365605567?mt=8) [![google-play](https://shootismoke.github.io/assets/images/play-store.png)](https://play.google.com/store/apps/details?id=com.shitismoke.app)

Expand All @@ -25,7 +26,7 @@ This app is bootstrapped with [Expo](https://expo.io), you can download the Expo

| Release Channel | Version | Description | Url |
| --------------- | ------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| Production | v1.3.1 | Same version as Sh\*\*t! I Smoke on the App Store and Play Store. | `https://exp.host/@amaurymartiny/shoot-i-smoke?release-channel=production` |
| Production | v1.4.0 | Same version as Sh\*\*t! I Smoke on the App Store and Play Store. | `https://exp.host/@amaurymartiny/shoot-i-smoke?release-channel=production` |
| Staging | v1.4.0 | Latest version currently in development: newest features, may contain bugs. | `https://exp.host/@amaurymartiny/shoot-i-smoke` |

## :hammer: Build it yourself
Expand All @@ -48,13 +49,14 @@ git clone https://github.com/amaurymartiny/shoot-i-smoke
cd shoot-i-smoke
yarn install

# Replace the API keys placeholders with your own tokens in app.json
# For the optional services you don't want to put an API key, put `undefined`
# Copy the file that contains secrets
cp app.example.json app.json

yarn start
```

In `app.json`, replace all the placeholders for API keys and tokens with the ones you generated for yourself. For those that are optional, you can just put `null` (without quotes).

This app is created with Expo, using React Native. When you run `yarn start`, the Expo packager will show, and you can either:

- install the Expo app, scan the displayed QR code, and run the app on your mobile phone directly.
Expand Down

0 comments on commit 9e86a1f

Please sign in to comment.