Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
gozeloglu committed Feb 13, 2021
1 parent 170e663 commit 0981f10
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# bm
![LICENSE](https://img.shields.io/badge/license-MIT-green)
![Proudly written in Bash](https://img.shields.io/badge/written%20in-bash-ff69b4.svg)
![VERSION](https://img.shields.io/badge/version-0.1.0-blue)

![](./img/logo.jpg)


**bm** comes from **Bookmark** as a short name. bm is a CLI tool for saving links on terminal easily. It has different features like adding new link, listing them, creating and saving under categories, deleting links or categories.

## Motivation

I always use terminal while making development. It stays open everytime. I compile, run, test the code or commiting the changes on GitHub on the terminal. In short, I try to do all my jobs while coding on the terminal. Again, due to my personal characteristics, I want to control my jobs from one place if it is possible. I mean I do not like to work with lots of different windows and tools. I try to manage all stuff from one or two applications/tools. I know there are different tools or ways to manage bookmarks, but I do not like using any other tools/applications except the necessary ones like IDE, terminal. That's why I wanted to build a CLI tool that manages the bookmarks. Also, the minor motivation was applying the **Bash** knowledge to real-world project.
I always use terminal while making development. It stays open everytime. I compile, run, test the code or commiting the changes on GitHub on the terminal. In short, I try to do all my jobs while coding on the terminal. Again, due to my personal characteristics, I want to control my jobs from one place if it is possible. I mean I do not like to work with lots of different tools. I try to manage all stuff from one or two applications/tools. I know there are different tools or ways to manage bookmarks, but I do not like using any other tools/applications except the necessary ones like IDE, terminal. That's why I wanted to build a CLI tool that manages the bookmarks. Also, the minor motivation was applying the **Bash** knowledge to real-world project.

## Example

Expand All @@ -24,10 +28,28 @@ $ ./bm delete 1 3 4 # Delete the given bookmark ids in default category, bm
$ ./bm delete -c Reading 1 4 5 # Delete the given bookmark ids by given category
```

## Usage

If you want to see usage of the command, just add `--help` or `-h` flag as follow.

```shell
$ ./bm --help # CLI usage
$ ./bm add --help # add usage
$ ./bm list --help # list usage
$ ./bm delete --help # delete usage
$ ./bm remove --help # remove usage
```

You can enter multiple category or id in commands. **bm** handles all of them. There is an exception for it when you want to delete bookmarks by category. You need to type just one category. Otherwise, **bm** understands them as a bookmark id.

## Demo

![bm demo](img/demo.gif)

## Contribution

Contributions are welcome. But, the project is still under development by me. That's why I may not accept the pull requests from you, but we can discuss in issues if you open issue.

# LICENSE

[MIT](./LICENSE)

0 comments on commit 0981f10

Please sign in to comment.