Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tmo1 committed Feb 16, 2024
1 parent 7b716ea commit 7edde07
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,12 @@ The primary author of SMS Import / Export is [Thomas More](https://github.com/tm
- [Oğuz Ersen (ersen0 / oerson)](https://github.com/oersen): updates to Turkish translation
- [Raman](https://hosted.weblate.org/user/deleted-56119/): Malayalam translation
- Surena: Persian translation
- [ngocanhtve](https://github.com/ngocanhtve): Vietnamese translation

### Other

- [Onno van den Dungen (Donnno)](https://github.com/Donnnno): application icon ([Issue #20](https://github.com/tmo1/sms-ie/issues/20) / [PR #22](https://github.com/tmo1/sms-ie/pull/22))
- [Biswapriyo Nath (Biswa96)](https://github.com/Biswa96): monochrome icon ([issue #114](https://github.com/tmo1/sms-ie/issues/114) / [PR #132](https://github.com/tmo1/sms-ie/pull/132))
- [Biswapriyo Nath (Biswa96)](https://github.com/Biswa96): [GitHub workflow to automatically build and upload APKs containing the latest committed code](.github/workflows/build.yml) ([PR #99](https://github.com/tmo1/sms-ie/pull/99))
- [wittmane](https://github.com/wittmane), [dshepsis](https://github.com/dshepsis), and [sshaikh](https://github.com/sshaikh): figuring out broken `Subscription ID` handling on Android 14 ([Issue #128](https://github.com/tmo1/sms-ie/issues/128))
- [Artem13327](https://github.com/Artem13327): [Update to automatic build and upload Github workflow](https://github.com/tmo1/sms-ie/pull/158)
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# SMS Import / Export

![GitHub Release](https://img.shields.io/github/v/release/tmo1/sms-ie)
![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/tmo1/sms-ie)
![F-Droid Version](https://img.shields.io/f-droid/v/com.github.tmo1.sms_ie)

![GitHub issues](https://img.shields.io/github/issues/tmo1/sms-ie)
![GitHub closed issues](https://img.shields.io/github/issues-closed/tmo1/sms-ie)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/tmo1/sms-ie)

SMS Import / Export is a simple Android app that imports and exports SMS and MMS messages, call logs, and contacts from and to (ND)JSON files. (Contacts import and export are currently functional but considered experimental.) Root is not required.

[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
Expand Down Expand Up @@ -58,6 +66,14 @@ By default, binary MMS data (such as images and videos) are exported. The user c

Note that upon import or wipe, message apps present on the system may not immediately correctly reflect the new state of the message database due to app caching and / or local storage. This can be resolved by clearing such cache and storage, e.g. `Settings / Apps / Messaging / Storage & cache / Clear storage | Clear cache`.

## Import / Export Locations

SMS Import / Export does all input and output via the Android [Storage Access Framework (SAF)](https://developer.android.com/guide/topics/providers/document-provider). The app should thus be able to import from and export to any location available via the SAF, including both local storage (internal, SD card, or USB attached) as well as cloud storage accessible through the SAF, via either a dedicated app (e.g., the [Nextcloud Android App](https://github.com/nextcloud/android)) or [Rclone](https://rclone.org/) through [RSAF](https://github.com/chenxiaolong/RSAF).

### Encryption

[SMS Import / Export does not have any internal encryption / decryption functionality](https://github.com/tmo1/sms-ie/issues/82), and [there are currently no plans to add such functionality](https://github.com/tmo1/sms-ie/issues/82#issuecomment-1908098763). Instead, the currently recommended method for automatic encryption / decryption is to use an [Rclone crypt remote](https://rclone.org/crypt/) via [RSAF](https://github.com/chenxiaolong/RSAF) to transparently encrypt data as it is exported and decrypt it as it is imported. (The RSAF developer explains how to do this [here](https://github.com/tmo1/sms-ie/issues/82#issuecomment-1907097444), but cautions that he would only suggest this method for those already familiar with Rclone.) [Note](https://github.com/tmo1/sms-ie/issues/82#issuecomment-1908772982) that this method will only work for internal storage or cloud storage accessible via Rclone, but not for SD card or USB attached storage.

## Importing Messages

### Subscription IDs
Expand Down
2 changes: 2 additions & 0 deletions fastlane/metadata/android/en-US/changelogs/105.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Vietnamese translation - by ngocanhtve (PR #160)

0 comments on commit 7edde07

Please sign in to comment.