Skip to content

Commit

Permalink
renaming to fsrx
Browse files Browse the repository at this point in the history
  • Loading branch information
coloradocolby committed Jun 7, 2022
1 parent 3047ef2 commit c9258af
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Add a description of the systems where you are observing the issue.
- OS:
- Terminal Emulator:
- Font:
- `brx` version:
- `fsrx` version:

## Additional context

Expand Down
22 changes: 11 additions & 11 deletions Cargo.lock

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

14 changes: 7 additions & 7 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
[package]
name = "brx"
version = "0.1.2"
description = "📚 flow state bionic reading in the terminal"
name = "fsrx"
version = "0.2.0"
description = "📚 flow state reading in the terminal"
edition = "2021"
readme = "README.md"
repository = "https://github.com/coloradocolby/brx.git"
homepage = "https://github.com/coloradocolby/brx"
repository = "https://github.com/coloradocolby/fsrx.git"
homepage = "https://github.com/coloradocolby/fsrx"
license = "MIT"
authors = ["Colby Thomas <[email protected]>"]
exclude = ["assets/*", ".github/*",]
keywords = ["bionic", "reading", "utility", "terminal", "cli" ]
keywords = ["reading", "utility", "terminal", "cli", "fast" ]

[dependencies]
ansi_term = "0.12.1"
regex = "1.5.6"
unicode-segmentation = "1.9.0"
clap = { version = "3.1.18", features = ["derive"] }
atty = "0.2"
atty = "0.2.14"
50 changes: 28 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
# brx
# fsrx

📚(**f**)low (**s**)tate (**r**)eading e(**x**)change – flow state
reading in the terminal

📚(**b**)ionic (**r**)eading e(**x**)change – flow state [bionic
reading](https://bionic-reading.com/) in the terminal

[![GitHub CI
Workflow](https://github.com/coloradocolby/brx/actions/workflows/ci.yml/badge.svg)](https://github.com/coloradocolby/brx/actions/workflows/ci.yml)
Workflow](https://github.com/coloradocolby/fsrx/actions/workflows/ci.yml/badge.svg)](https://github.com/coloradocolby/fsrx/actions/workflows/ci.yml)
[![GitHub Deploy
Workflow](https://github.com/coloradocolby/brx/actions/workflows/deploy.yml/badge.svg)](https://github.com/coloradocolby/brx/actions/workflows/deploy.yml)
Workflow](https://github.com/coloradocolby/fsrx/actions/workflows/deploy.yml/badge.svg)](https://github.com/coloradocolby/fsrx/actions/workflows/deploy.yml)
[![License](https://img.shields.io/badge/License-MIT-default.svg)](./LICENSE.md)
[![Crate
Version](https://img.shields.io/crates/v/brx)](https://crates.io/crates/brx)
Version](https://img.shields.io/crates/v/fsrx)](https://crates.io/crates/fsrx)
[![Github
Stars](https://img.shields.io/github/stars/coloradocolby/brx)](https://github.com/coloradocolby/brx/stargazers)
Stars](https://img.shields.io/github/stars/coloradocolby/fsrx)](https://github.com/coloradocolby/fsrx/stargazers)

![demo](https://github.com/coloradocolby/assets/raw/main/brx/demo.gif)
![demo](https://github.com/coloradocolby/assets/raw/main/fsrx/demo.gif)

*Inspired by **(but not affiliated with)** Renato Casutt and his
revolutionary work on [Bionic Reading](https://bionic-reading.com).
Please consider supporting his mission to make Bionic Reading available
worldwide ❤️*
## Usage

For detailed usage run `brx -h`.
For detailed usage run `fsrx -h`.

```
brx 0.1.2
fsrx 0.2.0
Colby Thomas <[email protected]>
📚(b)ionic (r)eading e(x)change
flow state bionic reading in the terminal
📚(f)low (s)tate (r)eading e(x)change
flow state reading in the terminal
USAGE:
brx [OPTIONS] [PATH]
fsrx [OPTIONS] [PATH]
ARGS:
<PATH> path to file (or supply input via stdin)
Expand All @@ -42,32 +47,33 @@ OPTIONS:
### Examples

```sh
$ echo "the quick brown fox jumps over the lazy dog" | brx
$ brx input.txt | less
$ brx -c -fh -sl input.txt | less
$ echo "the quick brown fox jumps over the lazy dog" | fsrx
$ fsrx input.txt | less
$ fsrx -c -fh -sl input.txt | less
```

## Installation

### Cargo

```sh
$ cargo install brx
$ cargo install fsrx
```

### Homebrew

incoming @ [homebrew-brx](https://github.com/coloradocolby/homebrew-brx)
incoming @
[homebrew-fsrx](https://github.com/coloradocolby/homebrew-fsrx)

## Contributing

All contributions are greatly appreciated. Please keep in mind this
project is meant to be as lightweight as possible, so not every idea
will be considered.

If you have a suggestion that would make brx better, please fork the
If you have a suggestion that would make fsrx better, please fork the
repo and create a [pull
request](https://github.com/coloradocolby/brx/pulls). You can also
request](https://github.com/coloradocolby/fsrx/pulls). You can also
simply open an issue and select `Feature Request`

1. Fork the repo
Expand All @@ -77,8 +83,8 @@ simply open an issue and select `Feature Request`
5. Push to your branch (`git push origin [your_username]/xyz`)
6. Fill out pull request template

See the [open issues](https://github.com/coloradocolby/brx/issues) for a
full list of proposed features (and known issues).
See the [open issues](https://github.com/coloradocolby/fsrx/issues) for
a full list of proposed features (and known issues).

## License

Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use unicode_segmentation::UnicodeSegmentation;
#[clap(
author = "Colby Thomas <[email protected]>",
version,
about = "📚(b)ionic (r)eading e(x)change\nflow state bionic reading in the terminal"
about = "📚(f)low (s)tate (r)eading e(x)change\nflow state reading in the terminal"
)]
struct Cli {
/// path to file (or supply input via stdin)
Expand Down

0 comments on commit c9258af

Please sign in to comment.