Update readme
This commit is contained in:
parent
b531dadf96
commit
60f18fc6fb
29
README.md
29
README.md
|
@ -2,7 +2,9 @@
|
||||||
|
|
||||||
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" height="80"/>](https://play.google.com/store/apps/details?id=im.status.ethereum)
|
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" height="80"/>](https://play.google.com/store/apps/details?id=im.status.ethereum)
|
||||||
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80"/>](https://f-droid.org/packages/im.status.ethereum/)
|
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80"/>](https://f-droid.org/packages/im.status.ethereum/)
|
||||||
[<img src="doc/github_badge.png" alt="Get it on Github" height="80"/>](https://github.com/status-im/status-mobile/releases)
|
|
||||||
|
|
||||||
|
[Get it on Github](https://github.com/status-im/status-mobile/releases)
|
||||||
|
|
||||||
Join us in creating a browser, messenger, and gateway to a decentralized world. Status is a free (libre) open source mobile client targeting Android & iOS built entirely on [Ethereum](https://ethereum.org/) technologies. That's right, no middle men and `go-ethereum` running directly on your device.
|
Join us in creating a browser, messenger, and gateway to a decentralized world. Status is a free (libre) open source mobile client targeting Android & iOS built entirely on [Ethereum](https://ethereum.org/) technologies. That's right, no middle men and `go-ethereum` running directly on your device.
|
||||||
|
|
||||||
|
@ -20,31 +22,31 @@ If this interests you, **help us make Status a reality** - anyone can contribute
|
||||||
|
|
||||||
## How to Contribute?
|
## How to Contribute?
|
||||||
|
|
||||||
Go straight to the [docs](https://status.im/docs) or [join our chat](https://join.status.im/chat/public/status) and choose what interests you:
|
Go straight to the [docs](doc/) and choose what interests you:
|
||||||
|
|
||||||
- **Developer** Developers are the heart of software and to keep Status beating
|
- **Developer** Developers are the heart of software and to keep Status beating
|
||||||
we need all the help we can get! If you're looking to code in ClojureScript or
|
we need all the help we can get! If you're looking to code in ClojureScript or
|
||||||
Golang then Status is the project for you! We use React Native and there is even
|
Golang then Status is the project for you! We use React Native and there is even
|
||||||
some Java/Objective-C too! Want to learn more about it? Start by reading our
|
some Java/Objective-C too! Want to learn more about it? Start by reading our
|
||||||
[Developer Introduction](https://status.im/developer_tools/) which guides you
|
[Developer Introduction](doc/starting-guide.md) which guides you
|
||||||
through the technology stack and start browsing [beginner
|
through the technology stack and start browsing [beginner
|
||||||
issues](https://github.com/status-im/status-mobile/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3A%22good%20first%20issue%22%20).
|
issues](https://github.com/status-im/status-mobile/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3A%22good%20first%20issue%22%20).
|
||||||
Then you can read how to [Build
|
Then you can read how to [Build
|
||||||
Status](https://status.im/technical/build_status/), which talks about managing
|
Status](doc/starting-guide.md), which talks about managing
|
||||||
project dependencies, coding guidelines and testing procedures. The [doc/](doc/)
|
project dependencies, coding guidelines and testing procedures.
|
||||||
directory also has valuable information for contributors.
|
Check out our [coding guidelines](doc/new-guidelines.md).
|
||||||
|
|
||||||
- **Community Management**
|
- **Community Management**
|
||||||
Metcalfe's law states that the value of a network is proportional to the square of the number of connected users of the system - without community Status is meaningless. We're looking to create a positive, fun environment to explore new ideas, experiment and grow the Status community. Building a community takes a lot of work but the people you'll meet and long lasting relationships you form will be well worth it, check out our [Mission and Community Principles](https://status.im/about)
|
Metcalfe's law states that the value of a network is proportional to the square of the number of connected users of the system - without community Status is meaningless. We're looking to create a positive, fun environment to explore new ideas, experiment and grow the Status community. Building a community takes a lot of work but the people you'll meet and long lasting relationships you form will be well worth it, check out our [Mission and Community Principles](https://status.im/about)
|
||||||
|
|
||||||
- **Specification / Documentation**
|
- **Specification / Documentation**
|
||||||
John Dewey once said "Education is not preparation for life; education is life *itself* ". Developers & Designers need guidance and it all starts from documentation and specifications. Our software is only as good as its documentation, head over to our [docs](https://status.im/docs) and see how you can improve what we have.
|
John Dewey once said "Education is not preparation for life; education is life *itself* ". Developers & Designers need guidance and it all starts from documentation and specifications. Our software is only as good as its documentation, check out our [docs](doc/) and see how you can improve what we have.
|
||||||
|
|
||||||
- **Blog Writing**
|
- **Blog Writing**
|
||||||
Content is King, keeping our blog up to date and informing the community of news helps keep everyone on the same page. [Jump into our chat](https://join.status.im/chat/public/status) and discuss with the team how you can contribute!
|
Content is King, keeping our blog up to date and informing the community of news helps keep everyone on the same page.
|
||||||
|
|
||||||
- **Testers**
|
- **Testers**
|
||||||
It's bug hunting season! Status is currently under active development and there is sure to be a bunch of learning, [build status from scratch](https://status.im/technical/build_status/) or if an android user check out our [nightly builds](https://status.im/nightly). You can shake your phone to submit bug reports, or start browsing our [Github Issues](https://github.com/status-im/status-mobile/issues). Every bug you find brings Status closer to stable, usable software for everyone to enjoy!
|
It's bug hunting season! Status is currently under active development and there is sure to be a bunch of learning, [build status from scratch](doc/starting-guide.md) or if an android user check out our [nightly builds](https://status.im/nightly). You can shake your phone to submit bug reports, or start browsing our [Github Issues](https://github.com/status-im/status-mobile/issues). Every bug you find brings Status closer to stable, usable software for everyone to enjoy!
|
||||||
|
|
||||||
- **Security**
|
- **Security**
|
||||||
Status is a visual interface to make permanent changes on the Blockchain, it handles crypto-tokens that have real value and allows 3rd party code execution. Security is paramount to its success. You are given permission to break Status as hard as you can, as long as you share your findings with the community!
|
Status is a visual interface to make permanent changes on the Blockchain, it handles crypto-tokens that have real value and allows 3rd party code execution. Security is paramount to its success. You are given permission to break Status as hard as you can, as long as you share your findings with the community!
|
||||||
|
@ -52,9 +54,6 @@ Status is a visual interface to make permanent changes on the Blockchain, it han
|
||||||
- **Evangelism**
|
- **Evangelism**
|
||||||
Help us spread the word! Tell a friend *right now*, in fact tell **everyone** - yell from a mountain if you have to, every person counts! If you've got a great story to tell or have some interesting way you've spread the word about Status let us know about it in our [chat](https://join.status.im/chat/public/status)
|
Help us spread the word! Tell a friend *right now*, in fact tell **everyone** - yell from a mountain if you have to, every person counts! If you've got a great story to tell or have some interesting way you've spread the word about Status let us know about it in our [chat](https://join.status.im/chat/public/status)
|
||||||
|
|
||||||
## Status API
|
|
||||||
View our [API Docs](https://status.im/developer_tools/status_web_api.html) and learn how to integrate your DApp into Status. You can read more about how to add your DApp to Status [here](https://status.im/developer_tools/add_your_dapp.html).
|
|
||||||
|
|
||||||
## Give me Binaries!
|
## Give me Binaries!
|
||||||
|
|
||||||
You can get our Beta builds for both Android and iOS on our [website](https://status.im), through our [nightly builds](https://status.im/nightly/) or by [building it yourself](https://status.im/technical/build_status/).
|
You can get our Beta builds for both Android and iOS on our [website](https://status.im), through our [nightly builds](https://status.im/nightly/) or by [building it yourself](https://status.im/technical/build_status/).
|
||||||
|
@ -68,12 +67,8 @@ Without the dedication of these outstanding individuals, Status would not exist.
|
||||||
|
|
||||||
## Contact us
|
## Contact us
|
||||||
|
|
||||||
Feel free to email us at [support@status.im](mailto:support@status.im) or better yet, [join our chat](https://join.status.im/chat/public/status).
|
Feel free to email us at [support@status.im](mailto:support@status.im).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Licensed under the [Mozilla Public License v2.0](https://github.com/status-im/status-mobile/blob/develop/LICENSE.md)
|
Licensed under the [Mozilla Public License v2.0](https://github.com/status-im/status-mobile/blob/develop/LICENSE.md)
|
||||||
|
|
||||||
## Testing Supported by
|
|
||||||
|
|
||||||
[![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=SFBWQ3k5R2tnT2t6UGsxU1h1U0g3VFlCNnoxVTRHYWNoTDhsb1laaTJZWT0tLUZMUm5sSVFBSU9qSWM1RUJvK1I3Z3c9PQ==--ad15ae7992b432b33743749d40318952415bd98f)](https://www.browserstack.com/automate/public-build/SFBWQ3k5R2tnT2t6UGsxU1h1U0g3VFlCNnoxVTRHYWNoTDhsb1laaTJZWT0tLUZMUm5sSVFBSU9qSWM1RUJvK1I3Z3c9PQ==--ad15ae7992b432b33743749d40318952415bd98f)
|
|
||||||
|
|
Loading…
Reference in New Issue