+We're happy you're considering contributing to the Write.as command-line client!
+
+It won't take long to get up to speed on this. Here are our development resources:
+
+* We do our project management in [Phabricator](https://phabricator.write.as/tag/write.as_cli/).
+* We accept and respond to bugs here on [GitHub](https://github.com/writeas/writeas-cli/issues).
+* We're usually in #writeas on freenode, but if not, find us on our [Slack channel](http://slack.write.as).
+
+## Testing
+
+We try to write tests for all parts of the CLI, but aren't there yet. While not required, including tests with your new code will bring us closer to where we want to be and speed up our review.
+
+## Submitting changes
+
+Please send a [pull request](https://github.com/writeas/writeas-cli/compare) with a clear list of what you've done.
+
+Please follow our coding conventions below and make sure all of your commits are atomic. Larger changes should have commits with more detailed information on what changed, any impact on existing code, rationales, etc.
+
+## Coding conventions
+
+We strive for consistency above all. Reading the small codebase should give you a good idea of the conventions we follow.
+
+* We use `go fmt` before committing anything
+* We aim to document all exported entities
+* Go files are broken up into logical functional components
+* General functions are extracted into modules when possible
+
+## Design conventions
+
+We maintain a few high-level design principles in all decisions we make. Keep these in mind while devising new functionality:
+
+* Updates should be backwards compatible or provide a seamless migration path from *any* previous version
+* Each subcommand should perform one action and do it well
+* Each subcommand will ideally work well in a script
+* Avoid clever functionality and assume each function will be used in ways we didn't imagine
Command line interface for [Write.as](https://write.as) and [Write.as on Tor](http://writeas7pm7rcdqg.onion/). Works on Windows, OS X, and Linux.
Like the [Android app](https://play.google.com/store/apps/details?id=com.abunchtell.writeas), the command line client keeps track of the posts you make, so future editing / deleting is easier than [doing it with cURL](http://cmd.write.as/). The goal is for this to serve as the backend for any future GUI app we build for the desktop.
It is currently **alpha**, so a) functionality is basic and b) everything is subject to change — i.e., watch the [changelog](https://write.as/changelog-cli.html).
post Alias for default action: create post from stdin
new Compose a new post from the command-line and publish
delete Delete a post
update Update (overwrite) a post
get Read a raw post
add Add an existing post locally
list List local posts
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--tor, -t Perform action on Tor hidden service
--tor-port "9150" Use a different port to connect to Tor
--help, -h show help
--version, -v print the version
```
### Examples
These are a few common uses for `writeas`. If you get stuck or want to know more, run `writeas [command] --help`. If you still have questions, [ask us](https://write.as/contact).
#### Share something
Without any flags, `writeas` creates a post with a `monospace` typeface that doesn't word wrap (scrolls horizontally):
```bash
$ echo "Hello world!" | writeas
Posting...
Copied to clipboard.
https://write.as/aaaaaaaaaaaa
```
This is generally more useful for posting terminal output or code, like so (the `--code` flag turns on syntax highlighting):
OS X / *nix: `cat writeas/cli.go | writeas --code`
+This outputs any Write.as post with the given ID.
+
+```bash
+$ writeas get aaaaaaaaaaaa
+Getting...
+Hello world!
+```
+
+#### List all published posts
+
+This lists all posts you've published from your device. Pass the `--url` flag to show the list with full URLs.
+
+```bash
+$ writeas list
+aaaaaaaaaaaa
+```
+
+#### Delete a post
+
+This permanently deletes a post you own.
+
+```bash
+$ writeas delete aaaaaaaaaaaa
+Deleting...
+Post deleted.
+```
+
+#### Update a post
+
+This completely overwrites an existing post you own.
+
+```bash
+$ echo "See you later!" | writeas update aaaaaaaaaaaa
+Updating...
+Post updated.
+```
+
+### Composing posts
If you simply have a penchant for never leaving your keyboard, `writeas` is great for composing new posts from the command-line. Just use the `new` subcommand.
`writeas new` will open your favorite command-line editor, as specified by your `WRITEAS_EDITOR` or `EDITOR` environment variables (in that order), falling back to `vim` on OS X / *nix.
Customize your post's appearance with the `--font` flag:
| Argument | Appearance (Typeface) | Word Wrap? |
| -------- | --------------------- | ---------- |
| `sans` | Sans-serif (Open Sans) | Yes |
| `serif` | Serif (Lora) | Yes |
| `wrap` | Monospace | Yes |
| `mono` | Monospace | No |
| `code` | Syntax-highlighted monospace | No |
Put it all together, e.g. publish with a sans-serif font: `writeas new --font sans`