Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
4kimov committed Nov 27, 2023
1 parent 0db61e2 commit dea2741
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ Running the program requires Rust v1.69+. The following will output a complete J
cargo run
```

## Adding or Adjusting Data

**If you'd like to add a list or adjust a list, please submit PRs to the `next` branch.**

The `main` branch is frozen for this version of Sqids.

## Data

Lists of words are located in [data](data) folder.
Expand All @@ -34,4 +40,4 @@ Sqids ID matching that will cause a re-run (in order):
1. If the word has numbers, then match will happen only if ID starts or ends with that mutated word
1. Otherwise, only if the word is a substring of ID

Most common matches are from 4 letter words.
Most common matches are from 4 letter words.

0 comments on commit dea2741

Please sign in to comment.