Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Bookkeeping

**TODO: Add description**
Access the project from this link: [Bookkeeping]( https://github.com/jeryldev/bookkeeping)

## Installation

Expand All @@ -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 <https://hexdocs.pm/bookkeeping>.

## Clone the repository

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you could rename this part as "How to contribute?"



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
```