session-android/README.md

74 lines
3.6 KiB
Markdown
Raw Normal View History

2014-05-09 12:45:45 +02:00
# TextSecure [![Build Status](https://travis-ci.org/WhisperSystems/TextSecure.svg?branch=master)](https://travis-ci.org/WhisperSystems/TextSecure)
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
TextSecure is a messaging app for easy private communicate with friends.
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
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.
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
Currently available on the Play store.
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
*[![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)*
2013-12-16 18:58:56 +01:00
2014-04-26 00:52:03 +02:00
## 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!
2013-12-16 18:58:56 +01:00
2014-04-26 00:52:03 +02:00
https://github.com/WhisperSystems/TextSecure/issues
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
## Contributing Translations
Interested in helping to translate TextSecure? Contribute here:
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
https://www.transifex.com/projects/p/textsecure-official/
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
## 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).
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
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.
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
For larger changes and feature ideas, we ask that you propose it on the mailing list for a high-level discussion before implementation.
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
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:
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
[![Current BitHub Price](https://bithub.herokuapp.com/v1/status/payment/commit/)](https://whispersystems.org/blog/bithub/)
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
## 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!
2011-12-20 19:20:44 +01:00
whispersystems@lists.riseup.net
https://lists.riseup.net/www/info/whispersystems
2014-04-26 00:52:03 +02:00
## Contributing Funds
[![Donate](https://coinbase.com/assets/buttons/donation_large-6ec72b1a9eec516944e50a22aca7db35.png)](https://whispersystems.org/blog/bithub/)
2012-09-14 05:50:31 +02:00
2014-04-26 00:52:03 +02:00
You can add funds to BitHub to directly help further development efforts.
2012-09-14 05:50:31 +02:00
2014-04-26 00:52:03 +02:00
Help
====
## Support
For troubleshooting and questions, please visit our support center!
2012-09-14 05:50:31 +02:00
2014-04-26 00:52:03 +02:00
http://support.whispersystems.org/
2014-04-26 00:52:03 +02:00
## Documentation
Looking for documentation? Check out the wiki!
2014-04-26 00:52:03 +02:00
https://github.com/WhisperSystems/TextSecure/wiki
2014-04-26 00:52:03 +02:00
# Legal things
## Cryptography Notice
2011-12-20 19:20:44 +01:00
2014-04-26 00:52:03 +02:00
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.
2011-12-20 19:20:44 +01:00
See <http://www.wassenaar.org/> for more information.
2014-04-26 00:52:03 +02:00
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.
2011-12-20 19:20:44 +01:00
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.
2014-04-26 00:52:03 +02:00
## License
2011-12-20 19:20:44 +01:00
Copyright 2011 Whisper Systems
2014-04-26 00:52:03 +02:00
Copyright 2013-2014 Open Whisper Systems
2011-12-20 19:20:44 +01:00
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html