Skip to content

Commit

Permalink
Update README.md and Cargo.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
benjib-2 committed Sep 4, 2024
1 parent 826fc1c commit 84a5de6
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 7 deletions.
7 changes: 3 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "ed"
version = "0.3.0"
authors = ["Matt Bell <[email protected]>"]
authors = ["Turbofish <[email protected]>"]
edition = "2018"
description = "Encode and Decode traits"
license = "MIT"
description = "A minimalist crate for deterministic binary encodings in Rust."
license = "Apache-2.0"

[dependencies]
ed-derive = { version = "0.3.0", path = "derive" }
Expand All @@ -15,4 +15,3 @@ lto = true

[profile.release]
lto = true

37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# ed (encode/decode)
<h1 align="left">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./ed-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="./ed.svg">
<img alt="ed" src="./ed.svg">
</picture>
</h1>

*A minimalist crate for deterministic binary encodings in Rust.*

Expand All @@ -7,8 +13,6 @@
[![Crate](https://img.shields.io/crates/v/ed.svg)](https://crates.io/crates/ed)
[![API](https://docs.rs/ed/badge.svg)](https://docs.rs/ed)

## Overview

This crate provides `Encode` and `Decode` traits which can be implemented for any type that can be converted to or from bytes, and implements these traits for many built-in Rust types. It also provides derive macros so that `Encode` and `Decode` can be easily derived for structs.

`ed` is far simpler than `serde` because it does not attempt to create an abstraction which allows arbitrary kinds of encoding (JSON, MessagePack, etc.), and instead forces focuses on binary encodings. It is also significantly faster than [`bincode`](https://docs.rs/bincode), the leading binary `serde` serializer.
Expand Down Expand Up @@ -50,3 +54,30 @@ assert_eq!(foo, Foo {
bytes.clear();
foo.encode_into(&mut bytes)?;
```
Ed is currently used by [Nomic](https://github.com/nomic-io/nomic), a blockchain powering decentralized custody of Bitcoin, built on [Orga](https://github.com/turbofish-org/orga).

## Contributing

Ed is an open-source project spearheaded by Turbofish. Anyone is able to contribute to Ed via GitHub.

[Contribute to Ed](https://github.com/turbofish-io/ed/contribute)

## Security

Ed is currently undergoing security audits.

Vulnerabilities should not be reported through public channels, including GitHub Issues. You can report a vulnerability via GitHub's Private Vulnerability Reporting or to Turbofish at `[email protected]`.

[Report a Vulnerability](https://github.com/turbofish-io/ed/security/advisories/new)

## License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use the files in this repository except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---

Copyright © 2024 Turbofish, Inc.
3 changes: 3 additions & 0 deletions ed-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions ed.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 84a5de6

Please sign in to comment.