fpo-rust 0.1.0

Fast license plate OCR inference in pure Rust - a port of fast-plate-ocr with ONNX model support
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
109

# Publishing to crates.io

This guide explains how to publish `fpo-rust` to crates.io.

## Prerequisites

1. Create an account on [crates.io](https://crates.io)
2. Generate an API token from your account settings
3. Login to crates.io via cargo:
   ```bash
   cargo login
   ```
   Then paste your API token when prompted.

## Publishing Steps

### 1. Update Version

Update the version in `Cargo.toml`:

```toml
[package]
version = "0.1.0"
```

### 2. Update CHANGELOG.md

Add a new section for the version with all notable changes.

### 3. Commit Changes

```bash
git add Cargo.toml CHANGELOG.md
git commit -m "Bump version to 0.1.0"
git push
```

### 4. Test Publishing (Dry Run)

```bash
cargo publish --dry-run --allow-dirty
```

This will:
- Package the crate
- Verify it compiles
- Show what would be uploaded

### 5. Publish to crates.io

```bash
cargo publish --allow-dirty
```

This will upload the crate to crates.io. It typically takes a few minutes for the package to appear on the crates.io website.

### 6. Verify

Visit `https://crates.io/crates/fpo-rust/` to verify the publication.

## Import in Projects

Once published, users can import `fpo-rust` like this:

```toml
[dependencies]
fpo-rust = "0.1"
```

Or pin to a specific version:

```toml
[dependencies]
fpo-rust = "0.1.0"
```

## Documentation

After publishing, API documentation is automatically generated and available at:
`https://docs.rs/fpo-rust/`

## Important Notes

- **Do not publish pre-release or experimental code**
- Always run tests before publishing: `cargo test`
- Use semantic versioning (MAJOR.MINOR.PATCH)
- Update README with any new features
- Ensure all examples in README are working

## Troubleshooting

### "crate name already exists"
- The crate name is already taken on crates.io
- Choose a different name and update `Cargo.toml`

### "Package size too large"
- Exclude unnecessary files in `Cargo.toml`:
  ```toml
  exclude = ["tests/", "examples/", ".github/"]
  ```

### "API token not recognized"
- Re-run `cargo login` and enter your token again
- Check your token hasn't expired on crates.io

## Support

For more information, see the [Cargo book on publishing](https://doc.rust-lang.org/cargo/publishing/index.html).