Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
michele-nuzzi committed May 22, 2023
1 parent 3f1a465 commit 0e9871d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@

## what is plu-ts?

```plu-ts``` wants to be a library to allow Cardano-related software to be written entirely in [typescript](https://www.typescriptlang.org/), in support for a wider developer ecosystem adoption and easier integration.
`plu-ts` is to be a library to allow Cardano-related software to be written entirely in [typescript](https://www.typescriptlang.org/), in support for a wider developer ecosystem adoption and easier integration.

the project is be composed mainly of two parts: on-chain and off-chain;

the on-chain part takes care of smart contracts creation
the off-chain one allows for transaction creation
the on-chain exports all the necessary for you to build your smart contract as an eDSL (_embedded_ Domain Specific Language)
the off-chain one allows you to build transactions

## Install

Expand All @@ -34,6 +34,10 @@ or, equivalently, you can install directly form this repository
npm install https://github.com/HarmonicLabs/plu-ts
```

## Get started

Have a look at the [`plu-ts` documentation](https://pluts.harmoniclabs.tech/docs/intro) where you can find some [example projects](https://pluts.harmoniclabs.tech/docs/examples/Hello%20World) to help you get started.

## Sponsors ❤️

the [sponsors.md](./sponsors.md) file contains a list of supportes of this project.
Expand Down

0 comments on commit 0e9871d

Please sign in to comment.