Skip to content

Commit

Permalink
add CONTRIBUTING and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard-Cao committed Jul 11, 2016
1 parent 216dcd6 commit 7a8b1ea
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 5 deletions.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing to Reading

Reading is an open source project write in React Native.

>No Profit, No Advertisement, Only Feelings
## Development Process

### Pull Requests

Please submit your pull request on the *master* branch.

*Before* submitting a pull request, please make sure the following is done…

1. Fork the repo and create your branch from `master`.
2. Add the copyright notice to the top of any new files you've added.
3. **Make sure your code lints** (`npm run lint <files touched>`).
4. Squash your commits (`git rebase -i`).

#### Copyright Notice for files

Copy and paste this to the top of your new file(s):

```JS
/**
*
* Copyright 2015 reading
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
```

## License

By contributing to Reading, you agree that your contributions will be licensed under its Apache License, Version 2.0.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Reading

![Reading_Logo](./Reading_Logo.png)

[![Join the chat at https://gitter.im/attentiveness/reading](https://badges.gitter.im/attentiveness/reading.svg)](https://gitter.im/attentiveness/reading)
Expand All @@ -11,12 +12,14 @@ Reading App Write In React-Native(Studying and Programing)
> No Profit, No Advertisement, Only Feelings
## Screenshot

![Reading_Splash](./screenshot/Reading_Splash.jpg) ![Reading_Main](./screenshot/Reading_Main.jpg)
![Reading_Drawer](./screenshot/Reading_Drawer.jpg) ![Reading_Article](./screenshot/Reading_Article.jpg)
![Reading_Share](./screenshot/Reading_Share.jpg) ![Reading_About](./screenshot/Reading_About.jpg)
![Reading_IOS_Main](./screenshot/Reading_IOS_Main.jpeg) ![Reading_IOS_Share](./screenshot/Reading_IOS_Share.jpeg)

## Download From Android Market

*From 360 Android Market:* [Download Reading](http://zhushou.360.cn/detail/index/soft_id/3217938?recrefer=SE_D_Reading)

*From Wandou Labs:* [Download Reading](http://www.wandoujia.com/apps/com.reading)
Expand All @@ -29,6 +32,7 @@ Reading App Write In React-Native(Studying and Programing)
* [Enzyme](https://github.com/airbnb/enzyme) for testing UI components and mock

## Development Workflow

### Step One
```
npm install -g react-native-cli
Expand All @@ -46,26 +50,29 @@ react-native start
npm test
```

## Importance
[Why unknow module "http"](https://github.com/attentiveness/reading/issues/4)

## Release Note

[Reading Release Note](https://github.com/attentiveness/reading/releases)

## OnLine Accident

[Reading Online Accident](./Reading_OnLine_Accident.md)

## Welcome

>* Star
>* Fork
>* PR
>* Issue
## Thanks All!
*@Reading_Team*
## Contributing

For more information about contributing PRs and issues, see our [Contribution Guidelines](https://github.com/attentiveness/reading/blob/master/CONTRIBUTING.md).

## Contributors

[@Richard-Cao](https://github.com/Richard-Cao)

## License

Apache License 2.0

0 comments on commit 7a8b1ea

Please sign in to comment.