From 3e43c2aa2fa66b8eff3fe586282a6e78d7c08c74 Mon Sep 17 00:00:00 2001 From: Fernando Ramirez Date: Sun, 28 Jul 2024 15:05:06 -0700 Subject: [PATCH] chore: update docs --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a986a38..4fcfdba 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,6 @@ Ube (ooh-bay) is a program that displays statistics about your code. Ube will sh - [Linux](#linux) - [Windows](#windows) - [Usage](#usage) -- [Common Issues](#common-issues) - [Contributing](#contributing) - [License](#license) @@ -30,6 +29,7 @@ Ube (ooh-bay) is a program that displays statistics about your code. Ube will sh - [Bubbles](https://github.com/charmbracelet/bubbles) - TUI components for Bubble Tea - [Lip Gloss](https://github.com/charmbracelet/lipgloss) - Style definitions for Bubble Tea - [Log](https://github.com/charmbracelet/log) - A minimal, colorful Go logging library + - [Cobra](https://github.com/spf13/cobra) - A Commander for modern Go CLI interactions ## Installation @@ -48,7 +48,7 @@ Ube (ooh-bay) is a program that displays statistics about your code. Ube will sh ``` 4. Verify the installation (might have to allow in settings): ``` - $ ube + $ ube -v ``` ### Linux @@ -70,7 +70,7 @@ Ube (ooh-bay) is a program that displays statistics about your code. Ube will sh ``` 5. Verify the installation: ```bash - $ ube + $ ube -v ``` ### Windows @@ -82,18 +82,24 @@ Ube (ooh-bay) is a program that displays statistics about your code. Ube will sh 3. Move the extracted binary (ube.exe) to a directory included in your system's PATH environment variable for convenient access. Alternatively, you can run the tool from its extracted location. 4. Verify the installation: ``` - $ ube + $ ube -v ``` ## Usage ```bash -$ ube ./your/path -``` +Ube is a code statistics tool for your terminal. + +Usage: + ube [path] [flags] -## Common Issues -### “ube” can’t be opened because Apple cannot check it for malicious software. -1. Naviagte to `Settings` > `Security & Privacy`. -2. Under `General` tab, click "Allow Anyway" next to the message about the app being blocked. +Examples: + $ ube /path/to/directory + $ ube /path/to/file.go + +Flags: + -h, --help help for ube + -v, --version version for ube +``` ## Contributing Contributions are welcome! Please check the [Contributing Guidelines](CONTRIBUTING.md) for a few helpful tips!