Permalink
Browse files

Markdownify README, just do the minimum

  • Loading branch information...
1 parent cf7a04d commit f4e8e77810ec730eeb27da24a8e2706f8f87d920 @jbarnette committed Sep 7, 2012
Showing with 6 additions and 6 deletions.
  1. +6 −6 README → README.md
View
@@ -1,12 +1,12 @@
-THIS IS A BRUTAL DISSECTION OF VINES. I'm experimenting with
+**THIS IS A BRUTAL DISSECTION OF VINES.** I'm experimenting with
extracting a slim vines-core with a bunch of gems layered on top of
it. This is totally broken and shouldn't be used by anybody.
There are no working development instructions right now. I suggest
starting with `bundle install --binstubs b --path vendor/bundle` if
you really must poke around.
-== Welcome to Vines
+# Welcome to Vines
Vines is an XMPP chat server that supports thousands of simultaneous connections
by using EventMachine for asynchronous IO. User data is stored in a SQL database,
@@ -20,24 +20,24 @@ immediately after starting the chat server at http://localhost:5280/chat/.
Additional documentation can be found at www.getvines.org.
-== Usage
+## Usage
1. gem install vines
2. vines init wonderland.lit
3. cd wonderland.lit && vines start
4. Login with your favorite chat program (iChat, Adium, Pidgin, etc.) to
start chatting!
-== Dependencies
+## Dependencies
Vines requires Ruby 1.9.2 or better. Instructions for installing the
needed OS packages, as well as Ruby itself, are available at
http://www.getvines.org/ruby.
-== Contact
+## Contact
* David Graham <david@negativecode.com>
-== License
+## License
Vines is released under the MIT license. Check the LICENSE file for details.

0 comments on commit f4e8e77

Please sign in to comment.