@harmoniclabs/plu-ts/README.md

An embedded DSL for Cardano smart contracts creation coupled with a library for Cardano transactions, all in Typescript

<p align="center">
  <img width="100px" src="./assets/logo/plu-ts.svg" align="center"/>
  <h1 align="center">plu-ts</h1>
  <p align="center">An embedded DSL for Cardano smart contracts creation coupled with a library for Cardano transactions, all in Typescript</p>

  <p align="center">
    <img src="https://img.shields.io/github/commit-activity/m/harmonicpool/plu-ts?style=for-the-badge" />
    <a href="https://twitter.com/hlabs_tech">
      <img src="https://img.shields.io/twitter/follow/hlabs_tech?style=for-the-badge&logo=twitter" />
    </a>
    <a href="https://twitter.com/MicheleHarmonic">
      <img src="https://img.shields.io/twitter/follow/MicheleHarmonic?style=for-the-badge&logo=twitter" />
    </a>
  </p>
</p>

## what is plu-ts?

`plu-ts` is 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 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

You can start playing with `plu-ts` by running the following command in your project root directory
```
npm install @harmoniclabs/plu-ts
```
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) 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.

Everyone of them is special and is contribuitng in making this software aviable for everyone.

Consider having a look at the [documentation](https://www.harmoniclabs.tech/plu-ts-docs/index.html) even if it is currently being written; feel free to contribute to the [`plu-ts-docs` repository](https://github.com/HarmonicLabs/plu-ts-docs)

## Project Catalyst

a collection of all proposals made in the past is in the [```catalyst-proposals.md```](./catalyst-proposals.md) file