Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seanpierce committed Jun 20, 2018
1 parent 4046e83 commit 6383556
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# PassMan
Passman is a Python-based password management application. Data is managed using Peewee and stored in a Sqlite3 database.
PassMan is a Python-based password management console application. Data is managed using Peewee and stored in a Sqlite3 database.

### Dependencies
* Python3
Expand All @@ -9,28 +9,28 @@ Passman is a Python-based password management application. Data is managed using
* `pip3 install peewee`

### Installation and Usage
* ```shell
$ git clone https://github.com/seanpierce/passman
$ cd passman
$ chmod +x passman.py
$ ./passman.py
```
```shell
$ git clone https://github.com/seanpierce/passman
$ cd passman
$ chmod +x passman.py
$ ./passman.py
```

**Notes:**
* It's helpful to alias "python" and "pip" to point towards the "python3" and "pip3" commands respectively
* ```shell
$ echo "alias python=python3" > ~/.bashrc
$ echo "alias pip=pip3" > ~/.bashrc
$ # for zsh users, replace .bachrc with .zshrc
```
**Notes:**
It's helpful to alias "python" and "pip" to point towards the "python3" and "pip3" commands respectively
```shell
$ echo "alias python=python3" > ~/.bashrc
$ echo "alias pip=pip3" > ~/.bashrc
$ # for zsh users, replace .bachrc with .zshrc
```

**TODO:**
* Copy project to PATH, execute with single command 'passman'

**Author:**
**Author:**
Sean Pierce Sumler

**License:**
**License:**
MIT, use at your own risk

For questions and comments please <a href="https://github.com/seanpierce/passman/issues/new">raise an issue</a>. <a href="https://github.com/seanpierce/passman/compare">Pull requests</a> always welcome, too. Thanks!

0 comments on commit 6383556

Please sign in to comment.