Skip to content

Commit

Permalink
docs: move further reading to bottom of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
egasimus committed Oct 20, 2023
1 parent 31655cb commit 97ca791
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[![Fadroma](./banner2.svg)](https://fadroma.tech)

Distributed application framework developed at [**Hack.bg**](https://hack.bg).
[Distributed application framework](https://fadroma.tech) developed at
[**Hack.bg**](https://hack.bg).

|Component|Package|Docs|
|-|-|-|
Expand All @@ -14,14 +15,6 @@ Distributed application framework developed at [**Hack.bg**](https://hack.bg).
|`@fadroma/scrt`|[![](https://img.shields.io/npm/v/@fadroma/scrt?color=%2365b34c&style=for-the-badge)](https://www.npmjs.com/package/@fadroma/connect)|[View docs](https://fadroma.tech/ts/modules/_fadroma_scrt.html)|
|`@fadroma/cw`|[![](https://img.shields.io/npm/v/@fadroma/cw?color=%2365b34c&style=for-the-badge)](https://www.npmjs.com/package/@fadroma/connect)|[View docs](https://fadroma.tech/ts/modules/_fadroma_cw.html)|

See [**https://fadroma.tech**](https://fadroma.tech) for overview or try the
[**getting started guide**](https://fadroma.tech/guide.html).

See the [**Fadroma Workshop**](https://github.com/hackbg/fadroma-workshop) repo
for a real-world example, which includes a step-by-step guide on how to build smart
contracts using the Fadroma Rust crate, and the [**Fadroma Factory Example**](https://fadroma.tech/factory.html)
for a guide to deploying your Rust contracts using the Fadroma TypeScript package.

</div>

---
Expand Down Expand Up @@ -240,3 +233,12 @@ of `Deployment` classes.
```typescript
// TODO
```
## Further reading
* [**Fadroma Workshop**](https://github.com/hackbg/fadroma-workshop) repo,
a step-by-step guide on how to build smart contracts using the Fadroma Rust crate.
* [**Fadroma Factory**](https://fadroma.tech/factory.html),
a guide to deploying your Rust contracts using the Fadroma TypeScript package,
via a factory pattern that enables your users to instantiate contracts in a controlled way.

0 comments on commit 97ca791

Please sign in to comment.