Skip to content

Commit ea3ec65

Browse files
authored
Update docs.rs & crates.io links + Remove mentions of old stark-felt crate (#59)
1 parent c03eebe commit ea3ec65

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,37 @@
55
[![GitHub Workflow Status](https://github.com/starknet-io/types-rs/actions/workflows/test.yml/badge.svg)](https://github.com/starknet-io/types-rs/actions/workflows/test.yml)
66
[![Project license](https://img.shields.io/github/license/starknet-io/types-rs.svg?style=flat-square)](LICENSE)
77
[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/starknet-io/types-rs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
8-
[![Rust docs](https://docs.rs/stark-felt/badge.svg)](https://docs.rs/stark-felt)
9-
[![Rust crate](https://img.shields.io/crates/v/stark-felt.svg)](https://crates.io/crates/stark-felt)
8+
[![Rust docs](https://docs.rs/starknet-types-core/badge.svg)](https://docs.rs/starknet-types-core)
9+
[![Rust crate](https://img.shields.io/crates/v/starknet-types-core.svg)](https://crates.io/crates/starknet-types-core)
1010

1111
This repository is an initiative by a group of maintainers to address the fragmentation in the Starknet Rust ecosystem and improve its interoperability. The key motivation behind this repository is to standardize the representation of the `Felt` (Field Element) type in Rust, which is massively used as the core and atomic type of the Cairo language and its Virtual Machine.
1212

1313
The `Felt` type is currently defined in many different crates and repositories, resulting in increased code complexity and performance issues due to the need for numerous conversions. This repository aims to mitigate these issues by providing a universal `Felt` type in Rust.
1414

1515
## Crates
1616

17-
This repository hosts three crates:
17+
This repository hosts two crates:
1818

19-
- `stark-felt`: This crate provides the universal Felt (Field Element) type for Cairo and STARK proofs.
20-
21-
- `starknet-types-core`: This crate focuses on Starknet types related to computation and execution, requiring performance and optimization for specific arithmetic and cryptographic operations.
19+
- `starknet-types-core`: This crate provides the universal Felt (Field Element) type for Cairo and STARK proofs. It also focuses on Starknet types related to computation and execution, requiring performance and optimization for specific arithmetic and cryptographic operations.
2220

2321
- `starknet-types-rpc`: This crate deals with Starknet types used in RPC communication, serde, and transport.
2422

2523
## Usage
2624

27-
You can include any of these crates in your library via crates.io or as a git dependency. For example, to include the `stark-felt` crate, add the following to your `Cargo.toml`:
25+
You can include any of these crates in your library via crates.io or as a git dependency. For example, to include the `starknet-types-core` crate, add the following to your `Cargo.toml`:
2826

2927
As a crates.io dependency:
3028

3129
```toml
3230
[dependencies]
33-
stark-felt = "0.0.1"
31+
starknet-types-core = "0.1.0"
3432
```
3533

3634
As a git dependency:
3735

3836
```toml
3937
[dependencies]
40-
stark-felt = { git = "https://github.com/starknet-io/types-rs" }
41-
starknet-types-core = { git = "https://github.com/starknet-io/types-rs.git", version = "0.0.1", default-features = false, features = ["serde"] }
38+
starknet-types-core = { git = "https://github.com/starknet-io/types-rs.git", version = "0.1.0", default-features = false, features = ["serde"] }
4239
```
4340

4441
## Build from source

0 commit comments

Comments
 (0)