https://github.com/isabelroses/izrss

An RSS feed reader for the terminal.
https://github.com/isabelroses/izrss

atom-reader charm charmbracelet rss rss-reader tui

Last synced: 19 days ago
JSON representation

An RSS feed reader for the terminal.

• Host: GitHub
• URL: https://github.com/isabelroses/izrss
• Owner: isabelroses
• License: gpl-3.0
• Created: 2024-04-11T23:36:47.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-30T08:05:00.000Z (7 months ago)
• Last Synced: 2024-05-01T14:16:56.623Z (7 months ago)
• Topics: atom-reader, charm, charmbracelet, rss, rss-reader, tui
• Language: Go
• Homepage:
• Size: 20.3 MB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


 
izrss


 
An RSS feed reader for the terminal.



 

![demo](./.github/assets/demo.gif)

### Usage & Customization

The main bulk of customization is done via the `~/.config/izrss/config.toml` file. You can find an example file here [config.toml](./example.toml).

The rest of the config is done via using the environment variables `GLAMOUR_STYLE`.

For a good example see: [catppuccin/glamour](https://github.com/catppuccin/glamour)

Then run `izrss` to read the feeds.

### Installation

#### With Nix flakes and home-manager

```nix

{

  inputs = {

    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    home-manager = {

      url = "github:nix-community/home-manager";

      inputs.nixpkgs.follows = "nixpkgs";

    };

    izrss.url = "github:isabelroses/izrss";

  };

  outputs = { self, nixpkgs, home-manager, izrss }: {

    homeConfigurations."user@hostname" = home-manager.lib.homeManagerConfiguration {

      modules = [

        home-manager.homeManagerModules.default

        izrss.homeManagerModules.default

        {

          programs.izrss = {

            enable = true;

            settings.urls = [

              "https://isabelroses.com/rss.xml"

              "https://uncenter.dev/feed.xml"

            ];

          };

        }

      ];

    };

  }

}

```

#### With Nix flakes

```nix

{

  inputs = {

    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    izrss.url = "github:isabelroses/izrss";

  };

  outputs = { self, nixpkgs, izrss }: {

    nixosConfigurations.example = nixpkgs.lib.nixosSystem {

      system = "x86_64-linux";

      modules = [{

        environment.systemPackages = [

          inputs.izrss.packages.${pkgs.system}.default

        ];

      }];

    };

  }

}

```