Skip to content
Browse files

Add a bit more to README and fix a few typos

  • Loading branch information...
1 parent b397be6 commit d2db34692a8e4c6a62095a697747156c3b2ed1bd @wingrunr21 wingrunr21 committed Feb 1, 2011
Showing with 6 additions and 3 deletions.
  1. +6 −3 README.rdoc
View
9 README.rdoc
@@ -2,6 +2,8 @@
This gem is designed to provide a Ruby interface to the {gitolite}[https://github.com/sitaramc/gitolite] git backend system. I am aiming to provide all management functionality that is available via the gitolite-admin repository (like SSH keys, repository permissions, etc)
+This gem is still under very active development. There are a number of issues with it still. It is not ready for production use.
+
== Features
* Allows for the creation and management of repos within gitolite
* Allows for the creation and deletion of SSH keys within gitolite
@@ -39,7 +41,7 @@ For now, this method can only be called on an existing gitolite-admin repo. Sup
=== SSH Key Management
- #Two ways to create keys, manually or from an existing key
+ #Two ways to create keys: manually or from an existing key
key = Gitolite::SSHKey.new("ssh-rsa", "big-public-key-blob", "email")
key2 = Gitolite::SSHKey.from_file("/path/to/ssh/key.pub")
@@ -54,12 +56,12 @@ For now, this method can only be called on an existing gitolite-admin repo. Sup
ga_repo.save
-When this method is called, all changes get written to the file system and staged in git. For the time being, gitolite assumes full control of the gitolite-admin repository. This means that any keys in the keydir that are not being track will be removed and any human changes to gitolite.conf will be erased.
+When this method is called, all changes get written to the file system and staged in git. For the time being, gitolite assumes full control of the gitolite-admin repository. This means that any keys in the keydir that are not being tracked will be removed and any human changes to gitolite.conf will be erased.
=== Apply changes
ga_repo.apply
-This method will commit all changes with a generic message (will be improved upon later) and push to origin master.
+This method will commit all changes with a generic message (will be improved upon later) and push to <tt>origin master</tt>.
=== Save and apply
ga_repo.save_and_apply
@@ -69,6 +71,7 @@ This method will commit all changes with a generic message (will be improved upo
This gem should work properly on Ruby 1.8.x with the exception of deny rules. In order to fully support Ruby < 1.9.x, an ordered Hash is required. The one implemented by ActiveSupport could probably be used. Support will be added if there appears to be a demand for it.
== Documentation
+* Rdoc is coming soon
== Future
* support folders in the keydir

0 comments on commit d2db346

Please sign in to comment.
Something went wrong with that request. Please try again.