grim/hgkeeper

Fix some typos in the readme
draft
6 months ago, Gary Kramlich
e86ba80834b8
Parents 9f746cdbf79b
Children d3f0b014ec49
Fix some typos in the readme
  • +12 -8
    README.md
  • --- a/README.md Fri Apr 10 03:31:07 2020 -0500
    +++ b/README.md Mon Apr 13 22:45:44 2020 -0500
    @@ -1,9 +1,10 @@
    # hgkeeper
    hgkeeper is an server for [mercurial](https://www.mercurial-scm.org/)
    -repositories. It provides access control for SSH access.
    +repositories. It provides access control for SSH access and public HTTP
    +access via hgweb.
    -It's original design is to be run in a container, but there are plans to make
    +Its original design is to be run in a container, but there are plans to make
    it run stand-alone as well.
    ## License
    @@ -12,8 +13,9 @@
    ## Status
    -This project is brand new and not even functional yet... But if you're
    -interested in helping, please do!!
    +This project is brand new and only lightly tested. If you find issues, or are
    +looking for ways to help, please check out our
    +[issue tracker](https://issues.imfreedom.org/issues/HGKEEPER).
    ## Building
    @@ -63,7 +65,7 @@
    This can be done via `hgkeeper setup`. You will need to pass the arguments
    `--admin-username` which is the name of the admin user, as well as
    `--admin-pubkey` which is the path to the SSH public key for the new admin
    -user. By default this we create a new repository under `repos/hgkeeper`.
    +user. By default this will create a new repository under `repos/hgkeeper`.
    There are some additional options which you can discover via
    `hgkeeper setup --help`.
    @@ -75,13 +77,15 @@
    ## Usage
    -hgkeeper has a couple modes of operation but `serve` is the main mode.
    +hgkeeper has a couple of modes of operation but `serve` is the main mode.
    ### setup
    The `setup` command is used to bootstrap hgkeeper. It will create the
    -directory for the repositores, the hgkeeper repository, and create an initial
    -`access.yml`.
    +directory for the repositories as well as the hgkeeper repository.
    +
    +After initial setup, please make sure to read the README.md in the hgkeeper
    +repository as it details how access control works.
    ### serve