Unverified Commit a8707cc7 authored by Michael Müller's avatar Michael Müller Committed by GitHub
Browse files

Link `ink-docs` in readme (#647)

* Fix typos

* Add `ink-docs` link to readme
parent 1daf6a8e
Pipeline #122084 failed with stages
in 7 minutes and 35 seconds
......@@ -32,11 +32,16 @@
<br/>
[Guided Tutorial for Beginners](https://substrate.dev/substrate-contracts-workshop/#/0/building-your-contract)
[`cargo-contract`](https://github.com/paritytech/cargo-contract) cli tool for ink! contracts •
[Canvas UI](https://paritytech.github.io/canvas-ui/#/upload) for contract deployment/interaction •
Talk to us on [Element][k2] or [Discord][l2]
[ink! Documentation Portal](https://paritytech.github.io/ink-docs)
<br/>
</div>
More relevant links:
* Talk to us on [Element][k2] or [Discord][l2]
* [`cargo-contract`](https://github.com/paritytech/cargo-contract) ‒ cli tool for ink! contracts
* [Canvas UI](https://paritytech.github.io/canvas-ui/#/upload) ‒ webpage for contract deployment and interaction
## Table of Contents
* [Play with It](#play-with-it)
......@@ -85,7 +90,7 @@ The folder contains a scaffold `Cargo.toml` and a `lib.rs`, which both contain t
The `lib.rs` contains our hello world contract ‒ the `Flipper`, which we explain in the next section.
In order to build the contract just execute these commmands in the `flipper` folder:
In order to build the contract just execute these commands in the `flipper` folder:
```
cargo contract build
```
......@@ -221,6 +226,10 @@ The `#[ink::test]` proc. macro enables off-chain testing. See e.g. the [`example
## Developer Documentation
We have [a very comprehensive documentation portal](https://paritytech.github.io/ink-docs),
but if you are looking for the crate level documentation itself, then these are
the relevant links:
| Crate | Docs | Description |
|:--|:--|:--|
`ink_lang` | [![][j1]][j2] | Language features expose by ink!. See [here](https://paritytech.github.io/ink/ink_lang/attr.contract.html) for a detailed description of attributes which you can use in an `#[ink::contract]`. |
......
......@@ -388,7 +388,7 @@ pub fn transfer(&mut self, from: AccountId, to: AccountId, value: Balance) -> Re
One of the most anticipated features of ink! 3.0 is its Rust trait support.
Through the new `#[ink::trait_definition]` proc. macro it is now possible to define your very own trait definitions that are then implementable by ink! smart contracts.
This allows to defined shared smart contract interfaces to different concrete implementations.
This allows to define shared smart contract interfaces to different concrete implementations.
Note that this ink! trait definition can be defined anywhere, even in another crate!
### Example
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment