Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -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."
Expand Down
221 changes: 112 additions & 109 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -63,124 +63,126 @@ cargo install --path .
<details>
<summary>Flake</summary>

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
];
...
}
```

</details>

<details>
<summary>Non-Flake</summary>

##### 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
];
}
```

</details>

### Usage
Expand Down Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.