diff --git a/README.md b/README.md index 56fc382a93..07bfef1261 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,73 @@ -TextSecure -================= +# TextSecure -A secure text messaging application for Android. +TextSecure is a messaging app for easy private communicate with friends. -TextSecure is a replacement for the standard text messaging application, allowing you to send and receive text messages as normal. Additionally, TextSecure provides: +TextSecure can use either data (WiFi/3G/4G) or SMS to communicate securely, and all TextSecure +messages can also be encrypted locally on your device. -1. *Local Encryption* -- All text messages, regardless of destination, that are sent or received with TextSecure are stored in an encrypted database on your phone. -2. *Wire Encryption* -- When communicating with a recipient who is also using TextSecure, text messages are encrypted during transmission. +Currently available on the Play store. -Current BitHub Payment For Commit: -================= -[![Current Price](https://bithub.herokuapp.com/v1/status/payment/commit/)](https://whispersystems.org/blog/bithub/) +*[![Play Store Badge](https://developer.android.com/images/brand/en_app_rgb_wo_60.png)](https://play.google.com/store/apps/details?id=org.thoughtcrime.securesms)* -Building and contributing code -============================== -Instructions on how to build TextSecure, as well as on how to setup an IDE to modify it can be found in the "BUILDING.md" file. - -Bug tracker ------------ - -Have a bug? Please create an issue here on GitHub! +## Contributing Bug reports +We use GitHub for bug tracking. Please search the existing issues for your bug and create a new one if the issue is not yet tracked! https://github.com/WhisperSystems/TextSecure/issues +## Contributing Translations +Interested in helping to translate TextSecure? Contribute here: -Documentation -------------- +https://www.transifex.com/projects/p/textsecure-official/ -Looking for documentation? Check out the wiki! +## Contributing Code +Instructions on how to setup your development environment and build TextSecure can be found in [BUILDING.md](https://github.com/WhisperSystems/TextSecure/blob/master/BUILDING.md). -https://github.com/WhisperSystems/TextSecure/wiki +If you're new to the TextSecure codebase, we recommend going through our issues and picking out a simple bug to fix (check the "easy" label in our issues) in order to get yourself familiar. -Mailing list ------------- +For larger changes and feature ideas, we ask that you propose it on the mailing list for a high-level discussion before implementation. -Have a question? Ask on our mailing list! +This repository is set up with [BitHub](https://whispersystems.org/blog/bithub/), so you can make money for committing to TextSecure. The current BitHub price for an accepted pull request is: + +[![Current BitHub Price](https://bithub.herokuapp.com/v1/status/payment/commit/)](https://whispersystems.org/blog/bithub/) + +## Contributing Ideas +Have something you want to say about Open Whisper Systems projects or want to be part of the conversation? Get involved in the mailing list! whispersystems@lists.riseup.net https://lists.riseup.net/www/info/whispersystems -Translation ------------- +## Contributing Funds +[![Donate](https://coinbase.com/assets/buttons/donation_large-6ec72b1a9eec516944e50a22aca7db35.png)](https://whispersystems.org/blog/bithub/) -Interested in helping to translate TextSecure? Contribute here: +You can add funds to BitHub to directly help further development efforts. -https://www.transifex.com/projects/p/textsecure-official/ +Help +==== +## Support +For troubleshooting and questions, please visit our support center! -Downloads ------------- +http://support.whispersystems.org/ -TextSecure can be downloaded from the Play Store here: +## Documentation +Looking for documentation? Check out the wiki! -https://play.google.com/store/apps/details?id=org.thoughtcrime.securesms +https://github.com/WhisperSystems/TextSecure/wiki -Cryptography Notice ------------- +# Legal things +## Cryptography Notice -This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. -BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. +This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. +BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See for more information. -The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. +The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. -License ---------------------- +## License Copyright 2011 Whisper Systems -Copyright 2013 Open WhisperSystems + +Copyright 2013-2014 Open Whisper Systems Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html