Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pefontana committed Oct 23, 2023
1 parent 0ddba75 commit eff975d
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions crates/starknet-types-core/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# stark-felt
# starknet-types-core

Field element representation for Cairo and STARK proofs.
Core types representation for Cairo and STARK proofs.

## Overview

The `stark-felt` crate provides the universal `Felt` (Field Element) type for Cairo and STARK proofs. It was created to reduce the fragmentation in the Starknet Rust ecosystem by providing a standardized representation of the `Felt` type.
The `starknet-types-core` crate provides:
* The universal `Felt` (Field Element) type for Cairo and STARK proofs. It was created to reduce the fragmentation in the Starknet Rust ecosystem by providing a standardized representation of the `Felt` type.
* The `AffinePoint` and `ProjectivePoint` structs, that represent a point in the Stark curve with which you can operate

## Features

Expand All @@ -16,29 +18,29 @@ The `stark-felt` crate provides the universal `Felt` (Field Element) type for Ca
Here are some examples of how to use the `Felt` type:

```rust
// example code here
let x = Felt::from(18)
```

## Usage

Include `stark-felt` in your library by adding the following to your `Cargo.toml`:
Include `starknet-types-core` in your library by adding the following to your `Cargo.toml`:

```toml
[dependencies]
stark-felt = { version = "0.0.3", git = "https://github.com/starknet-io/types-rs" }
starknet-types-core = { version = "0.0.3", git = "https://github.com/starknet-io/types-rs" }
```

## Build from source

Clone the repository and navigate to the stark-felt directory. Then run:
Clone the repository and navigate to the starknet-types-core directory. Then run:

```bash
cargo build --release
```

## Testing

Clone the repository and navigate to the stark-felt directory. Then run:
Clone the repository and navigate to the starknet-types-core directory. Then run:

```bash
cargo test
Expand Down

0 comments on commit eff975d

Please sign in to comment.