diff options
| -rw-r--r-- | README.md | 75 | ||||
| -rw-r--r-- | README.org | 90 |
2 files changed, 90 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). diff --git a/README.org b/README.org new file mode 100644 index 0000000..1895cd8 --- /dev/null +++ b/README.org @@ -0,0 +1,90 @@ +* mastodon.el + +Emacs client for [[https://github.com/tootsuite/mastodon][Mastodon]] + +#+CAPTION: built with spacemacs +#+ATTR_HTML: :alt built with spacemacs :href http://spacemacs.org +[[https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg]] + +** Installation + +Clone this repository and add the lisp directory to your load path. +Then, require it and go. + +#+BEGIN_SRC emacs-lisp + (add-to-list 'load-path "/path/to/mastodon.el/lisp") + (require 'mastodon) +#+END_SRC + +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 [[https://mastodon.social][flagship]]. + +#+BEGIN_SRC emacs-lisp + (setq mastodon-instance-url "https://my.instance.url") +#+END_SRC + +*** 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 [[https://github.com/jdenen/mastodon.el/issues?q=is%3Aopen+is%3Aissue+label%3A%22road+to+1.0.0%22][here]]. + +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 [[https://github.com/jdenen/mastodon.el/issues][issue]] + 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 [[https://github.com/jdenen/mastodon.el/issues][issue]], 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 [[https://mastodon.social/@johnson][toot]] or leave an [[https://github.com/jdenen/mastodon.el/issues][issue]]. |