README.md in expandsync-0.1.1 vs README.md in expandsync-0.1.2
- old
+ new
@@ -1,17 +1,18 @@
-ExpandSync
+ExpandSync[![Build Status](https://travis-ci.org/bachya/ExpandSync.png?branch=master)](https://travis-ci.org/bachya/ExpandSync)
==========
-A simple engine to sync aText and TextExpander iOS.
+A simple engine to sync snippets between aText and TextExpander iOS. Because these two programs don't natively sync, it becomes necessary to introduce a tool that helps grease the skids, so to speak.
-# Installation
+# Prerequisites
- $ gem install expandsync
+* Install Ruby 1.9.3 or greater on the machine that will run ExpandSync.
+* Enable Dropbox syncing in TextExpander iOS.
-# Warning
+# Installation
-ExpandSync is still *heavily* in development; as such, expect this repository to change daily. **USE AT YOUR OWN DISCRETION.**
+ $ gem install expandsync
# Usage
TODO: Write better usage instructions
@@ -19,28 +20,51 @@
```
$ expandsync --help
Usage: expandsync [options] atext_filepath
-An engine for synchronizing snippets from aText on OS X and TextExpander iOS
+A command line app that synchronizes text expansion snippets between aText for OS X and TextExpander for iOS
-v0.1.0
+v0.1.2
Options:
-h, --help Show command line help
--version Show help/version info
- -a FILEPATH Specify an output location for aText rules (default to /Users/abach/aText-snippets.csv})
+ -a FILEPATH Output location for aText rules (defaults to ~/aText-snippets.csv)
-n Disable backing up of Settings.textexpander (RUN AT YOUR OWN RISK!)
- -t FILEPATH Specify a location for the TextExpander iOS XML file
-v, --verbose Turn on verbose output
Arguments:
atext_filepath
The filepath to a CSV file exported from aText
```
-# Contributing
+# Process
+
+Synchronizing these two applications follows this process:
+
+1. Export the current aText snippet list (**Data >> Backup To...**). Ensure that you export a CSV (not an aText) file.
+2. Run `expandsync /path/to/your/aText/file.csv`
+3. ExpandSync will calculate the snippets that are missing from aText and those that are missing from TextExpander iOs.
+4. Unique aText snippets will be automatically imported into TextExpander iOS via Dropbox.
+5. ExpandSync will output `aText-snippets.csv` – which contains snippets unique to TextExpander iOS – which can be imported into aText.
+
+# Caveats
+
+* Unfortunately, aText does not allow programmatic access to its snippet database; as such, there is a rather manual nature to this (you most likely won't be running this on a regular cron job).
+* Because neither aText nor TextExpander iOS tracks snippets that have been deleted, there's no way to tell both applications to simultaneously delete a snippet. I'm working on a "ask-the-user" method, but in the meantime, snippets will have to be manually deleted from both sides.
+* Currently, dynamic text – dates, etc. – are not translated between programs. I'm planning to address in a future version.
+
+# Known Issues & Future Releases
+
+Bugs, issues, and enhancement requests (my own or those submitted by others) can be found on the [Issues Page](https://github.com/bachya/ExpandSync/issues "Open Items").
+
+# Bugs and Feature Requests
+
+To report bugs with or suggest features/changes for Sifttter Redux, please use the [Issues Page](http://github.com/bachya/ExpandSync/issues).
+
+Contributions are welcome and encouraged. To contribute:
1. Fork it ( http://github.com/bachya/expandsync/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
\ No newline at end of file