Permalink
Browse files

Revise description in readme.

  • Loading branch information...
1 parent ca8ab2f commit 8c09e26fc19d76f3b2e674271273b6ffc637b6eb @mojombo mojombo committed Aug 6, 2010
Showing with 8 additions and 6 deletions.
  1. +8 −6 README.md
View
14 README.md
@@ -3,13 +3,15 @@ gollum -- A wiki built on top of Git
## DESCRIPTION
-Gollum is a simple wiki built on top of Git that powers GitHub Wikis. Gollum
-is designed so that you can create a compliant Git repository (known as a
-Gollum repository) either by hand, by calling API methods, or via the web
-interface.
+Gollum is a simple wiki system built on top of Git that powers GitHub Wikis.
-We are making the source available so that you may test your wikis locally if
-you choose to edit them by hand.
+Gollum wikis are simply Git repositories that adhere to a specific format.
+Gollum pages may be written in a variety of formats and can be edited in a
+number of ways depending on your needs. You can edit your wiki locally:
+
+* With your favorite text editor or IDE.
+* With the built-in web interface.
+* With the Gollum Ruby API.
Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
[TomDoc](http://tomdoc.org/) for inline documentation.

0 comments on commit 8c09e26

Please sign in to comment.