From 7c8684a863fbe995313c9f8ab5efbc2ae83ee410 Mon Sep 17 00:00:00 2001 From: Benji <67122503+benjib-2@users.noreply.github.com> Date: Wed, 4 Sep 2024 19:37:05 -0400 Subject: [PATCH 1/3] Update README.md and Cargo.toml --- Cargo.toml | 7 +++---- README.md | 37 ++++++++++++++++++++++++++++++++++--- ed-dark.svg | 3 +++ ed.svg | 3 +++ 4 files changed, 43 insertions(+), 7 deletions(-) create mode 100644 ed-dark.svg create mode 100644 ed.svg diff --git a/Cargo.toml b/Cargo.toml index 7b1096d..5b705aa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,10 +1,10 @@ [package] name = "ed" version = "0.3.0" -authors = ["Matt Bell "] +authors = ["Turbofish "] 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" } @@ -15,4 +15,3 @@ lto = true [profile.release] lto = true - diff --git a/README.md b/README.md index 8e0a509..3f2721d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -# ed (encode/decode) +

+ + + + ed + +

*A minimalist crate for deterministic binary encodings in Rust.* @@ -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. @@ -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 `security@turbofish.org`. + +[Report a Vulnerability](https://github.com/turbofish-org/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. \ No newline at end of file diff --git a/ed-dark.svg b/ed-dark.svg new file mode 100644 index 0000000..457438b --- /dev/null +++ b/ed-dark.svg @@ -0,0 +1,3 @@ + + + diff --git a/ed.svg b/ed.svg new file mode 100644 index 0000000..5863cae --- /dev/null +++ b/ed.svg @@ -0,0 +1,3 @@ + + + From 6359ee50baba601616ad3463de4dd6432ae12a8f Mon Sep 17 00:00:00 2001 From: Benji <67122503+benjib-2@users.noreply.github.com> Date: Fri, 6 Sep 2024 13:36:48 -0400 Subject: [PATCH 2/3] Update Cargo.toml --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 5b705aa..74a1f50 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ name = "ed" version = "0.3.0" authors = ["Turbofish "] edition = "2018" -description = "A minimalist crate for deterministic binary encodings in Rust." +description = "A minimalist crate for deterministic binary encodings ." license = "Apache-2.0" [dependencies] From 980f4d7264b23e8f2d0f88442ffd5664515d0c55 Mon Sep 17 00:00:00 2001 From: Matt Bell Date: Fri, 6 Sep 2024 13:46:06 -0400 Subject: [PATCH 3/3] Update Cargo.toml --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 74a1f50..1fdc28c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ name = "ed" version = "0.3.0" authors = ["Turbofish "] edition = "2018" -description = "A minimalist crate for deterministic binary encodings ." +description = "A minimalist crate for deterministic binary encodings" license = "Apache-2.0" [dependencies]