Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ISSUE #23]📝Update README.md #24

Merged
merged 1 commit into from
Nov 8, 2024
Merged

[ISSUE #23]📝Update README.md #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,37 @@ Cheetah String is designed to provide fast and efficient string operations with
- **Easy to integrate**: Simple, intuitive design to minimize the learning curve.
- **Cross-platform**: Compatible with major operating systems and development environments.

## How to use

To use **`Cheetah-String`**, first add this to your `Cargo.toml`:

```toml
[dependencies]
cheetah-string = "0.1.0"
```

### Bytes support

**Bytes** support is optional and disabled by default. To enable use the feature `bytes`.

```toml
[dependencies]
cheetah-string = { version = "1", features = ["bytes"] }
```

### Serde support

**serde** support is optional and disabled by default. To enable use the feature `serde`.

```toml
[dependencies]
cheetah-string = { version = "1", features = ["serde"] }
```

## Contributing

We welcome issues and pull requests to help build a more efficient string manipulation library together!

## License

**cheetah-string** is licensed under the [Apache License 2.0](https://github.com/mxsm/cheetah-string/blob/main/LICENSE) and [MIT license](https://github.com/mxsm/cheetah-string/blob/main/LICENSE-MIT)
Loading