From e4ec142370b83a3445e7a1ad0409cf865ff3018d Mon Sep 17 00:00:00 2001 From: Can Vardar Date: Tue, 5 Nov 2024 17:11:07 +0300 Subject: [PATCH 1/3] docs: add README file --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c36ff5e..bea75ce 100644 --- a/README.md +++ b/README.md @@ -1 +1,53 @@ -### arbor +# Arbor + +**Arbor** is a command-line application written in Rust, designed to provide quick, trie-based autocomplete suggestions. Arbor lets users enter words interactively and suggests completions based on the input prefix. + +## Interactive Mode + +In interactive mode, Arbor will prompt you to enter words or prefixes. Based on the entered text, it will provide autocomplete suggestions. + +1. **Adding Words**: Type a word and press Enter to add it to the trie. +2. **Autocomplete Suggestions**: Type a prefix and press Enter to see a list of words that match the prefix. + +### Example: +[![example-recording](https://asciinema.org/a/z5ytDJVDomEmKiu3Nezvkm8Zx.svg)](https://asciinema.org/a/z5ytDJVDomEmKiu3Nezvkm8Zx) + +## Features + +- **Interactive Autocomplete** - Provides word suggestions based on prefixes entered by the user. +- **Efficient and Lightweight** - Built with Rust for high performance and low memory usage. +- **Easy Installation** - Can be installed directly via Cargo. + +## Installation + +You can install Arbor using Cargo: + +```bash +cargo install arbor +``` + +## Usage + +After installation, simply run `arbor` in your terminal: + +```bash +arbor +``` + +### Command-Line Options + +- **`-l`, `--language `**: Specifies the language for suggestions (e.g., `en-US`). +- **`-t`, `--thread-count `**: Sets the number of threads for processing (e.g., `4`). +- **`-m`, `--max-suggestion `**: Limits the number of suggestions returned for a prefix (e.g., `5`). +- **`-b`, `--backup`**: Enables backup mode. When this flag is set, you must also specify the `--output` option. +- **`-o`, `--output `**: Specifies the file path for saving backup suggestions (only applicable if `--backup` is enabled). + +To exit the application, you can use `Ctrl+C` or `Esc`. + +## Contributing + +Contributions are welcome! Feel free to fork the repository, open issues, or submit pull requests. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. From 9e316bf990625de3a362e0cded73b6c307ed2667 Mon Sep 17 00:00:00 2001 From: Can Vardar Date: Tue, 5 Nov 2024 17:11:42 +0300 Subject: [PATCH 2/3] Revert "docs: add README file" This reverts commit e4ec142370b83a3445e7a1ad0409cf865ff3018d. --- README.md | 54 +----------------------------------------------------- 1 file changed, 1 insertion(+), 53 deletions(-) diff --git a/README.md b/README.md index bea75ce..c36ff5e 100644 --- a/README.md +++ b/README.md @@ -1,53 +1 @@ -# Arbor - -**Arbor** is a command-line application written in Rust, designed to provide quick, trie-based autocomplete suggestions. Arbor lets users enter words interactively and suggests completions based on the input prefix. - -## Interactive Mode - -In interactive mode, Arbor will prompt you to enter words or prefixes. Based on the entered text, it will provide autocomplete suggestions. - -1. **Adding Words**: Type a word and press Enter to add it to the trie. -2. **Autocomplete Suggestions**: Type a prefix and press Enter to see a list of words that match the prefix. - -### Example: -[![example-recording](https://asciinema.org/a/z5ytDJVDomEmKiu3Nezvkm8Zx.svg)](https://asciinema.org/a/z5ytDJVDomEmKiu3Nezvkm8Zx) - -## Features - -- **Interactive Autocomplete** - Provides word suggestions based on prefixes entered by the user. -- **Efficient and Lightweight** - Built with Rust for high performance and low memory usage. -- **Easy Installation** - Can be installed directly via Cargo. - -## Installation - -You can install Arbor using Cargo: - -```bash -cargo install arbor -``` - -## Usage - -After installation, simply run `arbor` in your terminal: - -```bash -arbor -``` - -### Command-Line Options - -- **`-l`, `--language `**: Specifies the language for suggestions (e.g., `en-US`). -- **`-t`, `--thread-count `**: Sets the number of threads for processing (e.g., `4`). -- **`-m`, `--max-suggestion `**: Limits the number of suggestions returned for a prefix (e.g., `5`). -- **`-b`, `--backup`**: Enables backup mode. When this flag is set, you must also specify the `--output` option. -- **`-o`, `--output `**: Specifies the file path for saving backup suggestions (only applicable if `--backup` is enabled). - -To exit the application, you can use `Ctrl+C` or `Esc`. - -## Contributing - -Contributions are welcome! Feel free to fork the repository, open issues, or submit pull requests. - -## License - -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. +### arbor From 87b0e900c5dffb94b24fef248dfb14e8ee43d460 Mon Sep 17 00:00:00 2001 From: Can Vardar Date: Tue, 5 Nov 2024 18:41:26 +0300 Subject: [PATCH 3/3] chore: update Cargo.toml --- Cargo.toml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index f18f5a3..fc4c7ba 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,11 @@ name = "arbor" version = "0.1.0" edition = "2021" +authors = ["Can Vardar "] +description = "A trie-based auto-completion tool." +readme = "./README.md" +license-file = "./LICENSE" +keywords = ["autocomplete", "cli", "trie"] [dependencies] bincode = "1.3.3"