diff --git a/README.md b/README.md index 808554f..1a2b549 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Bookkeeping **TODO: Add description** +Access the project from this link: [Bookkeeping]( https://github.com/jeryldev/bookkeeping) ## Installation @@ -15,7 +16,35 @@ def deps do end ``` -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) +Documentation can be generated with [ExDoc](https://github.comc/elixir-lang/ex_doc) and published on [HexDocs](https://hexdocs.pm). Once published, the docs can be found at . +## Clone the repository + + +Open a terminal and run the following git command: + +``` +gh repo clone jeryldev/bookkeeping +``` + +## Create a branch + +Change to the repository directory on your computer (if you are not already there): + +``` +cd Bookkeeping +``` + +Now create a branch using the `git checkout -b` command: + +``` +git checkout -b B-item-version/short-description +``` + +For example: + +``` +git checkout -b B-3.02/add-credo-and-fix-mispelled-words +``` \ No newline at end of file