human_ids 0.1.0

Generate human-readable IDs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

<h1 align="center">human-ids</h1>
<p align="center">
    <a href="https://github.com/sondr3/human-ids/actions"><img alt="GitHub Actions Status" src="https://github.com/sondr3/human-ids/workflows/pipeline/badge.svg" /></a>
    <a href="https://crates.io/crates/human_ids"><img alt="Crates" src="https://img.shields.io/crates/v/human_ids.svg" /></a>
    <a href="https://crates.io/crates/human-ids-bin"><img alt="Crates" src="https://img.shields.io/crates/v/human-ids-bin.svg" /></a>
</p>

<p align="center">
    <b>Create simple human readable IDs</b>
</p>

<details>
<summary>Table of Contents</summary>
<br />

- [What](#what)
- [Library](#library)
  - [Usage](#usage)
  - [Installation](#installation)
- [Binary](#binary)
  - [Usage](#usage)
  - [Completion](#completion)
  - [Help](#help)
  - [Installation](#installation)
- [License](#license)
</details>

## What?

This is a Rust "fork" of the TypeScript/JavaScript library [`human-id`](https://github.com/RienNeVaPlus/human-id)
written by [RienNeVaPlus](https://github.com/RienNeVaPlus), just rewritten in Rust. Used to generate friendly
IDs like those used in `changesets`. Can be used either as a library or a binary.

## Library

### Installation

1. Add id: `cargo add human_ids`
2. Use it: `use human_ids::generate(None)`

## Usage

For usage documentation, see the [docs.rs](https://docs.rs/human_ids) page.

## Binary

### Usage

```shell
$ human_ids -h
Usage: human_ids [OPTIONS]

Options:
      --completion <COMPLETION>
          Generate shell completion scripts [possible values: bash, elvish, fish, powershell, zsh]
  -s, --separator <SEPARATOR>
          The separator to use between words [default: -]
  -c, --capitalize
          Capitalize each word
  -a, --adverb
          Add an adverb
  -n, --num-adjectives <NUM_ADJECTIVES>
          The number of adjectives to use [default: 1]
  -h, --help
          Print help (see more with '--help')
  -V, --version
          Print version

$ human_ids -s '~' -c
Happy~Mirrors~Matter
```

### Completion

If your method of installation didn't include shell completion, you can manually
source or save them with the `human_ids --completion <shell>` command.

### Help

Finally, help is always available with `human-ids -h` (or `--help` if your installation
included man pages).

### Installation

Currently, the package is available a couple of places, including Homebrew, AUR and Nix.

<dl>
  <dt>Cargo</dt>
  <dd><code>cargo install human-ids-bin</code></dd>

  <dt>Homebrew</dt>
  <dd>
    <ol>
      <li><code>brew tap sondr3/homebrew-taps</code></li>
      <li><code>brew install human-ids-bin</code></li>
    </ol>
  </dd>
</dl>

You can also download the matching release from the [release
tab](https://github.com/sondr3/human-ids/releases), extracting the archive and
placing the binary in your `$PATH`. Note that for Linux the
`unknown-linux-musl.tar.gz` is preferred as it is statically linked and thus
should run on any Linux distribution.

# LICENSE

MIT.