#+Title: SX -- Stack Exchange for Emacs

[[https://travis-ci.org/vermiculus/sx.el][https://travis-ci.org/vermiculus/sx.el.svg?branch=master]]
[[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]]

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
- ~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 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
- Advanced searching
- Writing questions, answers, and comments (with source code in its
  native major mode)
- Notifications
- Reputation reporting
- ...

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)~
This should give you access to the only entry point function at the
moment, ~sx-tab-frontpage~.

Eventually, this package will be available on MELPA.

* 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]] (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
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]]