diff options
| author | fap <fap-@users.noreply.github.com> | 2017-04-12 05:37:10 +0200 |
|---|---|---|
| committer | Johnson Denen <johnson.denen@gmail.com> | 2017-04-12 18:48:07 -0400 |
| commit | b503c07c8480c8f57e72c3fdafa153ad9d47030f (patch) | |
| tree | 8b7e8e5e870417477dcd7c1d83bcbb8027519767 /README.md | |
| parent | 0c80780a32b6a70c4da30c53fb2f646d6ac79b7a (diff) | |
Fixes #19 Change README.md to README.org
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 75 |
1 files changed, 0 insertions, 75 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index a41c954..0000000 --- a/README.md +++ /dev/null @@ -1,75 +0,0 @@ -# mastodon.el -Emacs client for [Mastodon](https://github.com/tootsuite/mastodon) - -[](http://spacemacs.org) - -## Installation - -Clone this repository and add the lisp directory to your load path. Then, require it and go. - -```elisp -(add-to-list 'load-path "/path/to/mastodon.el/lisp") -(require 'mastodon) -``` - -I'll make mastdon.el available on MELPA when I feel like it's reached a stable state. - -## Usage - -### Instance - -Set `mastodon-instance-url` in your `.emacs` or `customize`. Defaults to the [flagship](https://mastodon.social). - -```elisp -(setq mastodon-instance-url "https://my.instance.url") -``` -### App registration - -`M-x mastodon-register` - -Retrieves `client_id` and `client_secret` tokens. They're stored in the `mastdon-token-file`. -This value can be customized too, and defaults to `${EMACS_HOME_DIRECTORY}/mastodon.plstore`. - -### Toot toot - -`M-x mastodon-toot` - -Pops a new buffer/window with a `mastodon-toot` minor mode. Enter the contents of your toot here. `C-c C-c` sends the toot. -`C-c C-k` cancels. Both actions kill the buffer and window. - -If you have not previously authenticated, you will be prompted for your account email and password. **NOTE**: Email and -password are NOT stored by mastodon.el. - -Authentication stores your access token in the `mastodon--api-token-string` variable. It is not stored on your filesystem, so -you will have to re-authenticate when you close/reopen Emacs. - -## Roadmap - -TODOs for the `1.0.0` release are as far as I plan to roadmap. Repo issues track the roadmap via a label. -Click [here](https://github.com/jdenen/mastodon.el/issues?q=is%3Aopen+is%3Aissue+label%3A%22road+to+1.0.0%22). - -Issues labeled as bugs should also be fixed before 1.0.0, but delievered is better than perfect, so I don't consider them blocking. - -Issues labeled as enhancements can happen whenever. - -## Contributing - -PRs, issues, and feature requests are very welcome! - -### Features - -1. Create an [issue](https://github.com/jdenen/mastodon.el/issues) detailing the feature you'd like to add. -2. I'll give you a thumbs up and assign you the issue. -3. Fork the repository and create a branch. -4. Create a pull request referencing the issue created in step 1. - -### Fixes - -1. In an [issue](https://github.com/jdenen/mastodon.el/issues), let me know that you're working to fix it. -2. I'll assign you the issue. -3. Fork the repository and create a branch. -4. Create a pull request referencing the issue from step 1. - -## Connect - -If you want to get in touch with me, give me a [toot](https://mastodon.social/@johnson) or leave an [issue](https://github.com/jdenen/mastodon.el/issues). |