Skip to content

Commit

Permalink
docs: updated documentation and usage descriptions (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
Yakitrak authored Mar 28, 2023
1 parent 7a1a8e7 commit 4216781
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 8 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@

![Obs Usage](./docs/obs-usage.png)

CLI made to search, open and creates notes in Obsidian. Written in [Go](https://go.dev/), built on top of existing [Obsidian URIs](https://help.obsidian.md/Advanced+topics/Using+obsidian+URI)

## Description

[Obsidian](https://obsidian.md/) is a powerful and extensible knowledge base application
that works on top of your local folder of plain text notes. This CLI tool will let you interact with the application using the terminal. You are currently able to open, search and create notes.
that works on top of your local folder of plain text notes. This CLI tool (written in [Go](https://go.dev/)) will let you interact with the application using the terminal. You are currently able to open, search, move, create and update notes.

## Install

Expand Down
2 changes: 1 addition & 1 deletion cmd/move.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ var shouldOpen bool
var moveCmd = &cobra.Command{
Use: "move",
Aliases: []string{"m"},
Short: "Move or rename note in vault and updated corresponding links (experimental feature)",
Short: "Move or rename note in vault and updated corresponding links",
Args: cobra.ExactArgs(2),
Run: func(cmd *cobra.Command, args []string) {
current := args[0]
Expand Down
6 changes: 2 additions & 4 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@ import (

var rootCmd = &cobra.Command{
Use: "obs",
Short: "obs - CLI to search and open notes in obsidian",
Long: `obs - CLI to search and open notes in obsidian
It can open a vault, open, search and create notes in your vault(s)`,
Short: "obs - CLI to open, search, move, create and update notes",
Long: "obs - CLI to open, search, move, create and update notes",
}

func Execute() {
Expand Down
Binary file modified docs/obs-usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4216781

Please sign in to comment.