Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
josueBarretogit authored Jun 5, 2024
1 parent f9ea0bb commit 15d568b
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,30 @@

Terminal tool to get you the best crates for your rust projects with a few keybindings, curated by [blessed.rs](https://blessed.rs/crates)

## Motivation
As you may know, the website blessed.rs compiles the most popular crates that almost any rust project needs, so I decided to make a program that lets you look at those crates and add
them to your rust projects right in your terminal.

## Showcase
![render1716250101340](https://github.com/josueBarretogit/get_blessed_rs/assets/144196149/2969f312-b973-4562-859e-01df5d9f84ed)

![showcase](https://github.com/josueBarretogit/get_blessed_rs/assets/144196149/74841eda-d0c1-4db1-86b0-03638a622a33)

## Features


- Check out a crate documentation you can by pressing `<d>` (Opens a tab in your default web browser)
- Check out a crate crates.io page you can by pressing `<c>` (Opens a tab in your default web browser)
- Change categories with `<Tab>` or `<Shift + Tab>`
- Move up and down with either arroy keys or with `<j>` / `<k>`
- Select the crate you want to add to your project by pressing `<s>`
- Select all the crates from a category by pressing `<a>`
- Select a crate with features by pressing `<f>` to select its features
- Add the selected crates to your rust project by pressing `<Enter>`

![features](https://github.com/josueBarretogit/get_blessed_rs/assets/144196149/03d7dfbc-4ae6-4843-8175-c9fd249e99ed)


- After you are done press `<q>` or `<Esc>` to quit

## Installation

Expand All @@ -14,4 +35,6 @@ Terminal tool to get you the best crates for your rust projects with a few keybi

Arch Linux users can install [from the AUR](https://aur.archlinux.org/packages/get-blessed) via `paru -S get-blessed`.

After you are done adding the best crates to your rust project also consider making a .gitignore [add-gitignore-cli](https://crates.io/crates/add-gitignore-cli)

Please feel free to suggest new features or report any bugs / inconsistencies

0 comments on commit 15d568b

Please sign in to comment.