diff options
author | Sean Allred <code@seanallred.com> | 2014-11-14 01:10:20 -0500 |
---|---|---|
committer | Sean Allred <code@seanallred.com> | 2014-11-14 01:10:20 -0500 |
commit | 525a304f9aca38e1101a1d02ade26ec3b8e91b23 (patch) | |
tree | aa7da7e837c53e1276f08009788d460706714437 | |
parent | cfd909e8524c37ac3bc94bec56c4e577b2c33d2d (diff) |
Update README
-rw-r--r-- | README.org | 43 |
1 files changed, 36 insertions, 7 deletions
@@ -1,17 +1,46 @@ #+Title: Stack-Mode -#+Author: Sean Allred -#+Date: [2014-10-30 Thu] [[https://travis-ci.org/vermiculus/stack-mode][https://travis-ci.org/vermiculus/stack-mode.svg?branch=master]] [[https://gitter.im/vermiculus/stack-mode?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/stack-mode][https://badge.waffle.io/vermiculus/stack-mode.svg]] -=Stack-mode= hopes to be a full featured Stack Exchange mode for -GNU Emacs 24 and up. Using version 2.2, and subsequent versions as available, of -the Stack Exchange API we aim to create a more versatile experience of Stack Exchange inside of Emacs. +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. -This README will eventually hold a high-level feature list and details -on installation and configuration. +* Features +- ~list-questions~ :: + 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 =TAB= to fold questions and answers. +** 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-question-list)~ +This should give you access to the only entry point function at the +moment, ~list-questions~. + +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/stack-mode/issues/new][Open an issue]] |