Commit da006728 authored by Carey Metcalfe's avatar Carey Metcalfe

Clean up README

parent aeb285f4
## Translations
Please do not submit issues or pull requests for translation fixes. Anyone can update the translations in [Transifex](https://www.transifex.com/projects/p/smssecure/).
Please submit your corrections there.
## Submitting useful bug reports
1. Search our issues first to make sure this is not a duplicate.
1. Read the [Submitting useful bug reports guide](https://github.com/WhisperSystems/TextSecure/wiki/Submitting-useful-bug-reports) before posting a bug.
2. Read the [Submitting useful bug reports guide](https://github.com/WhisperSystems/TextSecure/wiki/Submitting-useful-bug-reports) before posting a bug.
## Development Ideology
......@@ -9,18 +16,18 @@ Truths which we believe to be self-evident:
1. **The answer is not more options.** If you feel compelled to add a
preference that's exposed to the user, it's very possible you've made
a wrong turn somewhere.
1. **The user doesn't know what a key is.** We need to minimize the points
2. **The user doesn't know what a key is.** We need to minimize the points
at which a user is exposed to this sort of terminology as extremely as
possible.
1. **There are no power users.** The idea that some users "understand"
3. **There are no power users.** The idea that some users "understand"
concepts better than others has proven to be, for the most part, false.
If anything, "power users" are more dangerous than the rest, and we
should avoid exposing dangerous functionality to them.
1. **If it's "like PGP," it's wrong.** PGP is our spirit guide for what
4. **If it's "like PGP," it's wrong.** PGP is our spirit guide for what
not to do.
1. **It's an asynchronous world.** Be wary of anything that is
5. **It's an asynchronous world.** Be wary of anything that is
anti-asynchronous: ACKs, protocol confirmations, or any protocol-level
"advisory" message.
1. **There is no such thing as time.** Protocol ideas that require synchronized
clocks are doomed to failure.
6. **There is no such thing as time.** Protocol ideas that require synchronized
clocks are doomed to failure.
# SMSSecure [![Build Status](https://travis-ci.org/SMSSecure/SMSSecure.svg?branch=master)](https://travis-ci.org/SMSSecure/SMSSecure)
SMSSecure is a messaging app for simple private communication with friends to communicate securely using SMS. This is a fork of [TextSecure](https://github.com/WhisperSystems/TextSecure), in which SMS encryption is not available anymore.
[SMSSecure](https://smssecure.org) is an SMS/MMS application that allows you to protect your privacy while communicating with friends.
## Goals of this fork
Using SMSSecure, you can send SMS messages and share media or attachments with complete privacy.
SMSSecure focuses on SMS. This fork aims to:
Features:
* Easy. SMSSecure works like any other SMS application. There's nothing to sign up for and no new service your friends need to join.
* Reliable. SMSSecure communicates using encrypted SMS messages. No servers or internet connection required.
* Private. SMSSecure uses the TextSecure encryption protocol to provide privacy for every message, every time.
* Safe. All messages are encrypted locally, so if your phone is lost or stolen, your messages are protected.
* Open Source. SMSSecure is Free and Open Source, enabling anyone to verify its security by auditing the code.
* Keep SMS encryption
* Drop Google services dependencies: push messages are not available in SMSSecure; if you want to keep them, SMSSecure is not for you.
## Migrating from TextSecure to SMSSecure
## Project goals
* In TextSecure, export plaintext backup. Warning: the backup will **not** be encrypted.
* Install SMSSecure.
* In SMSSecure, import plaintext backup.
* Enjoy SMSSecure!
This is a fork of [TextSecure](https://github.com/WhisperSystems/TextSecure) that aims to keep the SMS encryption that TextSecure removed [for a variety of reasons](https://whispersystems.org/blog/goodbye-encrypted-sms/).
Note: You will have to start new secured sessions.
SMSSecure focuses on SMS and MMS. This fork aims to:
## 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!
* Keep SMS/MMS encryption
* Drop Google services dependencies (push messages are not available in SMSSecure)
* Integrate upstream bugfixes and patches from TextSecure
https://github.com/SMSSecure/SMSSecure/issues
## Migrating from TextSecure to SMSSecure
* In TextSecure, export a plaintext backup. Warning: the backup will **not** be encrypted.
* Install SMSSecure.
* In SMSSecure, import he plaintext backup (this will import the TextSecure backup if no SMSSecure backup is found).
* Enjoy SMSSecure!
## Contributing Translations
We use Transifex for our translations. If you'd like to contribute, the project is here:
Note: You will have to start new secured sessions with your contacts.
https://www.transifex.com/projects/p/smssecure/
# Contributing
## Contributing Code
Instructions on how to setup your development environment and build SMSSecure can be found in [BUILDING.md](https://github.com/SMSSecure/SMSSecure/blob/master/BUILDING.md).
See [CONTRIBUTING.md](https://github.com/SMSSecure/SMSSecure/blob/master/CONTRIBUTING.md) for how to contribute code, translations, or bug reports.
If you're new to the SMSSecure 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.
Instructions on how to setup a development environment and build SMSSecure can be found in [BUILDING.md](https://github.com/SMSSecure/SMSSecure/blob/master/BUILDING.md).
Help
====
# Help
## Documentation
Looking for documentation? Check out the wiki of the original project:
......@@ -43,6 +46,7 @@ https://github.com/WhisperSystems/TextSecure/wiki
## Chat
Have a question? Want to help out? Join our IRC channel: [#SMSSecure on Freenode](https://webchat.freenode.net/?channels=SMSSecure)
# Legal
## 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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment