Skip to content

Commit 22393d1

Browse files
authored
Update README.md
1 parent be26664 commit 22393d1

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Codeowners
2-
The oxidation of an (existing CLI)[https://github.com/rubyatscale/code_ownership] written in Ruby.
2+
The oxidation of an [existing CLI](https://github.com/rubyatscale/code_ownership) written in Ruby.
33
This tool generates Github's `CODEOWNERS` file, assuming certain conventions around Ruby/Javascript packages.
44

55
`CODEOWNERS` generation happens as part of our git commit hooks and on Gusto's main repo takes ~18s to run. The Rust implementation which is a drop in replacement cuts that down to <= 2s. (Tested on a Mackbook M1)
@@ -29,7 +29,8 @@ Options:
2929
```
3030

3131
### Adoption
32-
This is an experimental tool and not currently supported by Gusto engineering foundational teams. It might stop working at any time. If you still wish to adopt it locally and get faster git commit hooks, do the following:
32+
This is an experimental port and might not ever be supported, use at your own risk and be preprare to fallback to the Ruby implementation if it stops working. if you still wish to adopt it, here are the instructions:
33+
3334
```bash
3435
# sets up a Rust toolchain
3536
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
@@ -43,8 +44,6 @@ cargo install --path .
4344
echo USE_CODEOWNERS_RS=true >> ~/.zshrc
4445
```
4546

46-
47-
4847
### Development
4948
The CLI is written in Rust. Rust provides strong type gurantees and an great ecosystem of CLI libraries. To be able to compile the code locally, you'll need to setup a rust compiler (See https://rustup.rs/):
5049

0 commit comments

Comments
 (0)