README.md in chronicle-email-0.1.1 vs README.md in chronicle-email-0.2.0
- old
+ new
@@ -1,16 +1,36 @@
# Chronicle::Email
+[](https://badge.fury.io/rb/chronicle-email)
-Email importer for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl)
+Extract and work with your email using the command line with this plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl).
-## Available classes
-- `email:mbox` - Extractor for processing .mbox files
-- `email:chronicle` - Transformer that converts an email into a chronicle schema
-
## Usage
-```bash
-gem install chronicle-etl
-gem install chronicle-email
+```sh
+# Install chronicle-etl and this plugin
+$ gem install chronicle-etl
+$ chronicle-etl plugins:install email
-chronicle-etl --extractor email:mbox --extractor-opts filename:"./mail.mbox" --transformer email:chronicle --loader stdout
-```
+# Process emails from an mbox file
+$ chronicle-etl --extractor email:mbox -i test.mbox --transformer email --fields subject
+```
+
+## Available Connectors
+### Extractors
+
+#### `mbox`
+Extractor for importing emails from an mbox file
+
+##### Settings
+- `input`: A path to an .mbox file
+
+### Transformers
+
+#### `email`
+Transform an email (in the form of a string) into Chronicle Schema
+
+##### Settings
+- `body_as_markdown`: (default: false) Whether to convert the email body into markdown
+- `remove_signature`: (default: true) Whether to attempt to strip out the email signature (using the [`email_reply_parser`](https://github.com/github/email_reply_parser) gem)
+
+## Roadmap
+- Add an IMAP (and gmail) extractor #1
\ No newline at end of file