Skip to content

Commit

Permalink
rename: StarknetByExample
Browse files Browse the repository at this point in the history
  • Loading branch information
enitrat committed Jun 26, 2023
1 parent 0f43836 commit f45cf35
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# CairoByExample
# StarknetByExample

## Description

CairoByExample is a collection of examples of how to use the [Cairo](https://github.com/starkware-libs/cairo) programming language to create smart contracts on Starknet.
StarknetByExample is a collection of examples of how to use the [Cairo](https://github.com/starkware-libs/cairo) programming language to create smart contracts on Starknet.

## Contribute

Expand Down
2 changes: 1 addition & 1 deletion Scarb.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "CairoByExample"
name = "StarknetByExample"
version = "0.1.0"

# See more keys and their definitions at https://docs.swmansion.com/scarb/docs/reference/manifest
Expand Down
6 changes: 3 additions & 3 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors = ["msaug"]
language = "en"
multilingual = false
src = "src"
title = "Cairo By Example"
title = "Starknet by Example"

[build]
# Eventual translations
Expand All @@ -13,6 +13,6 @@ title = "Cairo By Example"
after = ["links"]

[output.html]
git-repository-url = "https://github.com/NethermindEth/CairoByExample/"
edit-url-template = "https://github.com/NethermindEth/CairoByExample/edit/main/{path}"
git-repository-url = "https://github.com/NethermindEth/StarknetByExample/"
edit-url-template = "https://github.com/NethermindEth/StarknetByExample/edit/main/{path}"
playground.runnable = false
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Summary

- [Starknet by Example](./starknet-by-example.md)
- [Introduction to Cairo](./ch00-00-introduction.md)

- [Variables](./ch00-01-variables.md)
Expand Down
4 changes: 2 additions & 2 deletions src/ch00-00-introduction.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Introduction to Cairo
# Introduction to Cairo for Starknet smart contracts

This section will introduce you to the basics of smart contracts in Cairo.
The following chapters will introduce you to Starknet smart contracts and how to write them in Cairo.
8 changes: 8 additions & 0 deletions src/starknet-by-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Starknet by Example

Starknet By Example is a collection of examples of how to use the Cairo programming language to create smart contracts on Starknet.

Cairo is a Turing-complete programming language designed to write provable programs, abstracting the zk-STARK proof system away from the programmer.

If you want to learn more about the Cairo programming language, you can read the [Cairo Book](https://cairo-book.github.io/).
If you want to learn more about Starknet, you can read the [Starknet documentation](https://docs.starknet.io/) and the [Starknet Book](https://book.starknet.io).

0 comments on commit f45cf35

Please sign in to comment.