Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
wingrunr21 committed May 20, 2011
1 parent 6807bb1 commit 35be546
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.rdoc
Expand Up @@ -11,7 +11,6 @@ This gem is still under very active development. There are a number of issues w

== Issues
* Gem is not thread safe. For now, the gem will change directories in order to perform git operations. It will, however, return to the old working directory once it is finished. I am looking into making the gem thread safe.
* Deny rules do not maintain order. This is being worked on.

== Requirements
* Ruby 1.9.2 or higher
Expand Down Expand Up @@ -40,10 +39,20 @@ This method can only be called on an existing gitolite-admin repo. If you need

#Add repo
ga_repo.config.add_repo(repo)

#Delete repo
ga_repo.config.rm_repo(repo)

#Test if repo exists
ga_repo.config.has_repo?('cool_repo')

#Can also pass a Gitolite::Config::Repo object
repo = Gitolite::Config::Repo.new('cool_repo')
ga_repo.config.has_repo?(repo)

#Get a repo object from the config
repo = ga_repo.config.get_repo('cool_repo')

=== SSH Key Management

#Two ways to create keys: manually or from an existing key
Expand Down Expand Up @@ -101,7 +110,6 @@ Because the gem is still pre-release, I'd prefer not to take pull requests at th
* support folders in the keydir
* support include tags
* support pull operations to sync the local gitolite-admin repository with the server
* properly support deny rules
* cleanup methods to make adding and removing easier (like add_key should accept an array of keys)
* Rails integration
* Make the gem thread safe
Expand Down

0 comments on commit 35be546

Please sign in to comment.