Skip to content

Commit

Permalink
chore(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MathieuNls committed Mar 14, 2017
2 parents 65ceb7d + 103e987 commit 77cd643
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 23 deletions.
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ plugins/android.json
plugins/ios.json
www/
$RECYCLE.BIN/
src/assets/i18n/
src/assets/watches/
src/assets/i18n/*
src/assets/watches/*

.DS_Store

Thumbs.db
UserInterfaceState.xcuserstate
36 changes: 15 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,22 @@
[![devDependency Status][david-dev-badge]][david-dev-badge-url]
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)


# toolwatchapp-mobile
Mobile Apps

### Screens

- [x] Dashboard
- [x] Add Watch
- [x] Edit / Delete watch
- [x] Result
- [x] Login
- [x] Signup
- [x] Time

### Functionalities

- [x] List watches
- [x] Add/edit/delete watches
- [x] Login (email)
- [x] Signup (email)
- [x] Login fb
- [x] Social share

Thanks for your interest in contributing to the Toolwatch Mobile Apps! :tada:

This repository contains the code for our apps. The _core_ functionalities (shared accross web & mobiles) are hosted [here](https://github.com/Toolwatchapp/tw-core) while the backend is [here](https://github.com/Toolwatchapp/tw-backend)

## Creating an Issue

If you have a question about using toolwatch, please ask on us on the [Crisp](https://go.crisp.im/chat/embed/?website_id=-K4rBEcM_Qbt6JrISVzu).

If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been [reported](https://github.com/Toolwatchapp/tw-mobile/issues). You can search through existing issues to see if there is a similar one reported. Include closed issues as it may have been closed with a solution.


## Creating a Pull Request

We appreciate you taking the time to contribute! Before submitting a pull request, we ask that you please [create an issue](https://github.com/Toolwatchapp/tw-mobile/issues) that explains the bug or feature request and let us know that you plan on creating a pull request for it. If an issue already exists, please comment on that issue letting us know you would like to submit a pull request for it. This helps us to keep track of the pull request and make sure there isn't duplicated effort. You can also look for issues with the [pr_state:welcome](https://github.com/Toolwatchapp/tw-mobile/issues?q=is%3Aissue+is%3Aopen+label%3A%22pr_state%3A+welcome%22) label (![untitled](https://cloud.githubusercontent.com/assets/7218861/23103611/8014af38-f68b-11e6-8275-517663f83541.png)) if you want to contribute. These issues are ideals for a first contribution as they should be _relatively_ easy to fix.

[![Throughput Graph](https://graphs.waffle.io/Toolwatchapp/tw-mobile/throughput.svg)](https://waffle.io/Toolwatchapp/tw-mobile/metrics/throughput)

Expand Down

0 comments on commit 77cd643

Please sign in to comment.