aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorSean Allred <code@seanallred.com>2014-11-27 12:52:07 -0500
committerSean Allred <code@seanallred.com>2014-11-27 12:52:07 -0500
commitd5a68d158bb9a73dcf3cb6ee178422173f6023af (patch)
treeff7e9228c8c8d6fdea288d939d287c1c544687ac /README.org
parenta009b4ab0416f86dc313cf41adab1c41232df8fe (diff)
Update README
Diffstat (limited to 'README.org')
-rw-r--r--README.org34
1 files changed, 20 insertions, 14 deletions
diff --git a/README.org b/README.org
index cd26c31..df8d907 100644
--- a/README.org
+++ b/README.org
@@ -4,18 +4,22 @@
[[https://gitter.im/vermiculus/sx.el?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge][https://badges.gitter.im/Join Chat.svg]]
[[https://www.waffle.io/vermiculus/sx.el][https://badge.waffle.io/vermiculus/sx.el.svg]]
-StackMode will be a full featured Stack Exchange mode for GNU Emacs 24
-and up. Using the official API, we aim to create a more versatile
-experience for the Stack Exchange network within Emacs itself.
+SX will be a full featured Stack Exchange mode for GNU Emacs 24+.
+Using the official API, we aim to create a more versatile experience
+for the Stack Exchange network within Emacs itself.
* Features
-- ~list-questions~ ::
+- ~sx-tab-frontpage~ ::
List questions on a StackExchange site.
- Viewing Posts ::
- Use =jknp= to open questions from within ~list-questions~; use
=RET= to move focus.
- - Use =v= to open the site in your browser.
+ - Use =v= to open the object at point in your browser.
- Use =TAB= to fold questions and answers.
+ - Use =RET= to open a link at point.
+ - Use =:= to switch sites.
+ - Vote up and down with =u= and =d=.
+
** Planned
- Archiving questions for offline access
- Browsing and favoriting networks
@@ -30,35 +34,37 @@ Have a feature in mind that isn't on the list? Submit a pull request
to add it to the list! If you want to discuss it first, pop in our
Gitter chatroom (badge above) -- someone will be around shortly to
talk about it.
+
* Installation
To install the development version, follow the usual steps:
- Clone this repository
- Add this directory to your ~load-path~
-- Issue ~(require 'sx-question-list)~
+- Issue ~(require 'sx)~
This should give you access to the only entry point function at the
-moment, ~list-questions~.
+moment, ~sx-tab-frontpage~.
+
+Eventually, this package will be available on MELPA.
-Eventually, this package will at least be available on MELPA.
-Depending on community involvement, it may even be submitted to the
-official GNU ELPA.
* Contributing
Please help contribute! Doing any of the following will help us immensely:
- [[https://github.com/vermiculus/sx.el/issues/new][Open an issue]]
- [[https://github.com/vermiculus/sx.el/pulls][Submit a pull request]]
- - [[https://gitter.im/vermiculus/sx.el][Suggest a package or library in our Chat on Gitter]]
+ - [[https://gitter.im/vermiculus/sx.el][Suggest a package or library in our Chat on Gitter]] (or just hang out =:)=)
- Spread the word!
For a better view of all of the open issues, take a look at our lovely
[[http://www.waffle.io/vermiculus/sx.el][Waffle board]]. Feel free to take the torch on anything in =backlog= or
=ready=. If you have thoughts on any other issues, don't hesitate to
chime in!
+
* Resources
- [[http://www.gnu.org/software/emacs/][GNU Emacs]]
- [[https://api.stackexchange.com/docs][Stack Exchange API v2.2]]
+
** Icons
-Stack Exchange Mode for Emacs has no explicit use for an icon,
-although standard SVG files have been gathered in =resources/= if
-anyone would fancy a crack at it.
+SX has no explicit /need/ for an icon, although standard SVG files
+have been gathered in =resources/= if anyone would fancy a crack at
+it.
- [[file:resources/emacs.svg][Emacs icon]]
- [[file:resources/stackexchange.svg][Stack Exchange icon]]