Skip to content

Commit c5c4b5e

Browse files
authored
Merge pull request #19 from semaphore-protocol/v0.1.0-release
V0.1.0 release
2 parents e619f61 + 91bf51f commit c5c4b5e

File tree

5 files changed

+23
-13
lines changed

5 files changed

+23
-13
lines changed

Cargo.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
[package]
2-
name = "semaphore-rs"
3-
version = "0.1.0"
2+
name = "semaphore-protocol"
3+
version = "0.1.0-alpha.0"
44
edition = "2024"
5+
description = "Semaphore Rust Implementation"
6+
license = "MIT"
7+
repository = "https://github.com/semaphore-protocol/semaphore-rs"
8+
keywords = ["semaphore", "zk", "zero-knowledge", "proof", "cryptography"]
9+
categories = ["cryptography", "zk", "semaphore"]
10+
documentation = "https://semaphore.pse.dev/"
11+
readme = "README.md"
12+
13+
[lib]
14+
name = "semaphore"
515

616
[dependencies]
717
blake = "2.0.2"

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Add this to your `Cargo.toml`:
7575

7676
```toml
7777
[dependencies]
78-
semaphore-rs = "0.1"
78+
semaphore-protocol = "0.1"
7979
```
8080

8181
### 📜 Usage
@@ -84,7 +84,7 @@ semaphore-rs = "0.1"
8484

8585
- Generate a semaphore identity from a string
8686
```rust
87-
use semaphore_rs::identity::Identity;
87+
use semaphore::identity::Identity;
8888
let identity = Identity::new("secret".as_bytes());
8989
```
9090
- Get the identity commitment
@@ -101,13 +101,13 @@ semaphore-rs = "0.1"
101101
- Generate a group member from an identity
102102

103103
```rust
104-
use semaphore_rs::utils::to_element;
104+
use semaphore::utils::to_element;
105105
let member = to_element(*identity.commitment())
106106
```
107107

108108
- Generate a semaphore group from members
109109
```rust
110-
use semaphore_rs::group::{Element, Group};
110+
use semaphore::group::{Element, Group};
111111
const MEMBER1: Element = [1; 32];
112112
const MEMBER2: Element = [2; 32];
113113
let group = Group::new(&[
@@ -126,8 +126,8 @@ semaphore-rs = "0.1"
126126
- Generate a semaphore proof
127127

128128
```rust
129-
use semaphore_rs::proof::GroupOrMerkleProof;
130-
use semaphore_rs::proof::Proof;
129+
use semaphore::proof::GroupOrMerkleProof;
130+
use semaphore::proof::Proof;
131131

132132
let message = "message";
133133
let scope = "scope";
@@ -161,7 +161,7 @@ semaphore-rs = "0.1"
161161
```
162162
- Deserialize a semaphore proof
163163
```rust
164-
use semaphore_rs::proof::SemaphoreProof;
164+
use semaphore::proof::SemaphoreProof;
165165
let proof_imported = SemaphoreProof::import(&proof_json).unwrap();
166166
```
167167

tests/group.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ mod group {
7171
use ark_ed_on_bn254::Fq;
7272
use ark_ff::{BigInteger, PrimeField};
7373
use num_bigint::BigInt;
74-
use semaphore_rs::group::{EMPTY_ELEMENT, Element, Group};
74+
use semaphore::group::{EMPTY_ELEMENT, Element, Group};
7575
use std::str::FromStr;
7676

7777
fn str_to_element(s: &str) -> Element {

tests/identity.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ mod identity {
5959
use super::*;
6060
use ark_ed_on_bn254::{Fq, Fr};
6161
use ark_ff::{AdditiveGroup, BigInteger, PrimeField};
62-
use semaphore_rs::{
62+
use semaphore::{
6363
baby_jubjub::EdwardsAffine,
6464
error::SemaphoreError,
6565
identity::{Identity, Signature},

0 commit comments

Comments
 (0)