diff --git a/README.md b/README.md index 1dbc5a6f..22616e10 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# CairoByExample +# Starknet by Example ## 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. +Starknet by Example 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 diff --git a/Scarb.toml b/Scarb.toml index ddc5532d..c4314770 100644 --- a/Scarb.toml +++ b/Scarb.toml @@ -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 diff --git a/book.toml b/book.toml index c9a56893..07dca7d7 100644 --- a/book.toml +++ b/book.toml @@ -3,7 +3,7 @@ authors = ["msaug"] language = "en" multilingual = false src = "src" -title = "Cairo By Example" +title = "Starknet by Example" [build] # Eventual translations @@ -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 \ No newline at end of file diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 4a363092..cdaba3fb 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,5 +1,6 @@ Summary +- [Starknet by Example](./starknet-by-example.md) - [Introduction to Cairo](./ch00-00-introduction.md) - [Variables](./ch00-01-variables.md) diff --git a/src/ch00-00-introduction.md b/src/ch00-00-introduction.md index cd628156..1f27792a 100644 --- a/src/ch00-00-introduction.md +++ b/src/ch00-00-introduction.md @@ -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. diff --git a/src/starknet-by-example.md b/src/starknet-by-example.md new file mode 100644 index 00000000..f3bef604 --- /dev/null +++ b/src/starknet-by-example.md @@ -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).