From 490e016548218a9f5b8ef188d3ac55219d496dfe Mon Sep 17 00:00:00 2001 From: JayanAXHF Date: Wed, 4 Mar 2026 20:16:50 +0530 Subject: [PATCH 1/2] feat(branding): Add a logo --- README.md | 221 ++++++++++++++++++++++++------------------------ assets/logo.svg | 5 ++ 2 files changed, 117 insertions(+), 109 deletions(-) create mode 100644 assets/logo.svg diff --git a/README.md b/README.md index 5dfaab7..c5c3a53 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# gitv +![gitv logo](https://raw.githubusercontent.com/JayanAXHF/gitv/main/assets/logo.svg) [![Built With Ratatui](https://ratatui.rs/built-with-ratatui/badge.svg)](https://ratatui.rs/) ![crates.io](https://img.shields.io/crates/v/gitv-tui) @@ -63,124 +63,126 @@ cargo install --path .
Flake - First add the repository to your inputs. +First add the repository to your inputs. - Point to main branch: - - ```nix - inputs = { - ... - gitv.url = "github:JayanAXHF/gitv"; - ... - }; - ``` +Point to main branch: - Point to a rev in main branch: +```nix +inputs = { + ... + gitv.url = "github:JayanAXHF/gitv"; + ... +}; +``` - ```nix - inputs = { - ... - gitv.url = "github:JayanAXHF/gitv/d70273b05c5e80b05446e4aa0847758e54435d62"; - ... - }; - ``` +Point to a rev in main branch: - Point to a tag: +```nix +inputs = { + ... + gitv.url = "github:JayanAXHF/gitv/d70273b05c5e80b05446e4aa0847758e54435d62"; + ... +}; +``` - ```nix - inputs = { - ... - gitv.url = "github:JayanAXHF/gitv/refs/tags/gitv-tui-v0.3.2"; - ... - }; - ``` - - Then your outputs should look something like this: - - ```nix - outputs = {...} @ inputs: { - # Don't forget to add nixpkgs to your inputs - nixosConfigurations."nixos" = inputs.nixpkgs.lib.nixosSystem { - ... - specialArgs = {inherit inputs;}; - modules = [ - ./configuration.nix - ... - ]; - }; - }; - ``` - - And finally, somewhere in your `configuration.nix`: - - ```nix - {inputs, pkgs, ...}: { +Point to a tag: + +```nix +inputs = { ... - environment.systemPackages = [ - inputs.gitv.packages.${pkgs.stdenv.hostPlatform.system}.default - ]; + gitv.url = "github:JayanAXHF/gitv/refs/tags/gitv-tui-v0.3.2"; + ... +}; +``` + +Then your outputs should look something like this: + +```nix +outputs = {...} @ inputs: { + # Don't forget to add nixpkgs to your inputs + nixosConfigurations."nixos" = inputs.nixpkgs.lib.nixosSystem { ... - } - ``` + specialArgs = {inherit inputs;}; + modules = [ + ./configuration.nix + ... + ]; + }; +}; +``` + +And finally, somewhere in your `configuration.nix`: + +```nix +{inputs, pkgs, ...}: { + ... + environment.systemPackages = [ + inputs.gitv.packages.${pkgs.stdenv.hostPlatform.system}.default + ]; + ... +} +``` +
Non-Flake - - ##### Pinning Tool - - First add the pin using your pinning tool. - - We are going to show examples using npins. - - Point to a branch: - - ```bash - npins add github JayanAXHF gitv -b main - ``` - - Point to a rev in main branch: - - ```bash - npins add github JayanAXHF gitv -b main --at d70273b05c5e80b05446e4aa0847758e54435d62 - ``` - - Point to a tag: - - ```bash - npins add github JayanAXHF gitv --at gitv-tui-v0.3.2 - ``` - - Or point to latest release: - - ```bash - npins add github JayanAXHF gitv - ``` - - Then add the package to your `systemPackages`: - - ```nix - let - sources = import ./npins; - in { - environment.systemPackages = [ - (import sources.gitv {}) - ]; - } - ``` - - ##### No Pinning Tool - - ```nix - let - rev = "d70273b05c5e80b05446e4aa0847758e54435d62"; - gitv = import (fetchTarball "https://github.com/JayanAXHF/gitv/archive/${rev}.tar.gz") {}; - in { - environment.systemPackages = [ - gitv - ]; - } - ``` + +##### Pinning Tool + +First add the pin using your pinning tool. + +We are going to show examples using npins. + +Point to a branch: + +```bash +npins add github JayanAXHF gitv -b main +``` + +Point to a rev in main branch: + +```bash +npins add github JayanAXHF gitv -b main --at d70273b05c5e80b05446e4aa0847758e54435d62 +``` + +Point to a tag: + +```bash +npins add github JayanAXHF gitv --at gitv-tui-v0.3.2 +``` + +Or point to latest release: + +```bash +npins add github JayanAXHF gitv +``` + +Then add the package to your `systemPackages`: + +```nix +let + sources = import ./npins; +in { + environment.systemPackages = [ + (import sources.gitv {}) + ]; +} +``` + +##### No Pinning Tool + +```nix +let + rev = "d70273b05c5e80b05446e4aa0847758e54435d62"; + gitv = import (fetchTarball "https://github.com/JayanAXHF/gitv/archive/${rev}.tar.gz") {}; +in { + environment.systemPackages = [ + gitv + ]; +} +``` +
### Usage @@ -245,7 +247,8 @@ Contributions to `gitv` are welcome! If you have an idea for a new feature or ha > [!TIP] > Run the `init.py` initialization script to set up your development environment. It installs a pre-push hook that runs `typos` and `clippy` to help maintain code quality and consistency. Ensure that you have the `typos-cli` installed and available in your PATH for the pre-push hook to work correctly. You can install it using `cargo install typos-cli`. - [!TIP] +[!TIP] + > If you're using nix then you can use the provided devshell to get your development environment up and running, it also includes the pre-push hook provided. You can do so by executing `direnv allow` or `nix develop`. ### License diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000..392905b --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,5 @@ + + + + + From 9f5ed749a0ec19aeef817d242091def0299a526b Mon Sep 17 00:00:00 2001 From: Jayan Sunil <73993003+JayanAXHF@users.noreply.github.com> Date: Wed, 4 Mar 2026 20:18:21 +0530 Subject: [PATCH 2/2] chore(gitv-tui): release v0.3.3 --- CHANGELOG.md | 16 ++++++++++++++++ Cargo.lock | 2 +- Cargo.toml | 2 +- 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 14edf38..0022bf9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.3.3](https://github.com/JayanAXHF/gitv/compare/gitv-tui-v0.3.2...gitv-tui-v0.3.3) - 2026-03-04 + +### Added + +- *(branding)* Add a logo +- *(nix)* add devshell, package derivation, flake + +### Fixed + +- fix non-flake install instructions + +### Other + +- update usage in readme +- add install instructions for homebrew + ## [0.3.2](https://github.com/JayanAXHF/gitv/compare/gitv-tui-v0.3.1...gitv-tui-v0.3.2) - 2026-02-26 ### Added diff --git a/Cargo.lock b/Cargo.lock index 00f6bf8..02be60f 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1321,7 +1321,7 @@ dependencies = [ [[package]] name = "gitv-tui" -version = "0.3.2" +version = "0.3.3" dependencies = [ "anyhow", "async-trait", diff --git a/Cargo.toml b/Cargo.toml index e3cd1b3..2a7de64 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "gitv-tui" -version = "0.3.2" +version = "0.3.3" edition = "2024" build = "build.rs" description = "A terminal-based GitHub client built with Rust and Ratatui."