Skip to content

Commit

Permalink
ref: README file documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TheSnakeWitcher committed May 23, 2023
1 parent ad7cfc4 commit 0d8f8ee
Showing 1 changed file with 29 additions and 17 deletions.
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Index


1. [Purpose](#Purpose)
2. [Usage](#Usage)
3. [Installation](#Installation)
Expand All @@ -8,6 +9,7 @@
6. [Troubleshooting](#Troubleshooting)
7. [License](#License)


# Purpose


Expand All @@ -20,47 +22,51 @@ book because i find the last more intuitive.


### init command

```sh
# init db in default dir
# init db in default dir $HOME/.cache/mypeople/mypeople.db
mypeople init

# init db specific dir
# init db in path
mypeople init path
```

### add command

```sh
# add contact
# add a new contact
mypeople add contact_name

# add contacts fields to a existing contact
mypeople add contact_name -e "email_label:email_value"
# add fields to an existing contact
mypeople add contact_name -e "email_label:email_value" -s "social_media_label:social_media_value"

# add contacts with fields
# add a new contacts with fields
mypeople add new_contact_name -p "phone_label:phone_number" -w "wallet_label:wallet_address"
```

### ls command

```sh
# list all contacts with all his fields
mypeople ls

# list specific fields of all contacts
mypeople ls -espw

# list subset of contacts with all his fields
mypeople ls contact_name contact_name2

# list contact specific fields
mypeople ls contact_name -g -pe

# list specific fields of a subset of contacts
mypeople ls contact_name contact_name2 -sw
mypeople ls contact_name contact_name2 -es
```

### rm command

```sh
# remove specific contacts
mypeople rm contact_name1 contact_name2

# remove specific field from contact existing contact `contact_name`
# remove specific field from existing contact
mypeople rm contact_name -e email_label -p phone_label
```

Expand All @@ -78,22 +84,28 @@ make release

# Configuration

```sh
# create config file
mkdir -p $HOME/.config/mypeople/mypeople.toml
```

```sh
# create cache directory for store db
mkdir -p $HOME/.cache/mypeople
mkdir -p $HOME/.config/mypeople/mypeople.toml # create config file
mkdir -p $HOME/.cache/mypeople # create cache directory for store db
```

Config file `mypeople.toml` only support `dbfile`
which value is a path to a selected database created
with `mypeople init`.


# Documentation




# Troubleshooting




# License


MIT

0 comments on commit 0d8f8ee

Please sign in to comment.