Skip to content

Commit

Permalink
bump; refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
alessandrokonrad committed Jan 29, 2025
1 parent 29dada9 commit 3e7cc54
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 20 deletions.
6 changes: 2 additions & 4 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
src/core/libs/cardano_multiplatform_lib/cardano_multiplatform_lib.generated.js linguist-detectable=false
src/core/libs/cardano_multiplatform_lib/nodejs/cardano_multiplatform_lib.generated.js linguist-detectable=false
src/core/libs/cardano_message_signing/cardano_message_signing.generated.js linguist-detectable=false
src/core/libs/cardano_message_signing/nodejs/cardano_message_signing.generated.js linguist-detectable=false
src/core/libs/lucid_core/pkg/lucid_core_bg.js linguist-detectable=false
src/core/libs/message_signing/pkg/message_signing_bg.js linguist-detectable=false
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,7 @@
<p align="center">Lucid is a library designed to simplify creating Cardano transactions and writing off-chain code for Plutus contracts.</p>

<p align="center">
<a href="https://www.npmjs.com/package/lucid-cardano">
<img src="https://img.shields.io/npm/v/lucid-cardano?style=for-the-badge" />
</a>
<a href="https://doc.deno.land/https://deno.land/x/lucid/mod.ts">
<img src="https://img.shields.io/readthedocs/cardano-lucid?style=for-the-badge" />
</a>
<a href="https://www.npmjs.com/package/lucid-cardano">
<img src="https://img.shields.io/npm/dw/lucid-cardano?style=for-the-badge" />
</a>
<img src="https://img.shields.io/jsr/v/@spacebudz/lucid?style=for-the-badge" />
<img src="https://img.shields.io/npm/l/lucid-cardano?style=for-the-badge" />
<a href="https://twitter.com/spacebudznft">
<img src="https://img.shields.io/twitter/follow/spacebudznft?style=for-the-badge&logo=twitter" />
Expand All @@ -25,16 +17,22 @@

#### Deno 🦕

For JavaScript and TypeScript

```js
import { Lucid } from "jsr:@spacebudz/lucid";
```
or
```js
import { Lucid } from "https://deno.land/x/lucid/mod.ts";
```

#### NPM
#### Node.js

```
npm install lucid-cardano
npx jsr add @spacebudz/lucid
```
or
```
npm install lucid-cardano (legacy, will likely be obsolete)
```

`--experimental-wasm-modules` flag needs to be set in Node.js as well as `{ "type": "module" }` in package.json
Expand Down
5 changes: 5 additions & 0 deletions blueprint.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* This module contains functions to generate blueprints from plutus.json files.
* @module
*/

import type { Json } from "./mod.ts";

type Blueprint = {
Expand Down
2 changes: 1 addition & 1 deletion build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ try {
type: "module",
main: "./esm/mod.js",
engines: {
node: ">=18",
node: ">=20",
},
},
postBuild: async () => {
Expand Down
2 changes: 1 addition & 1 deletion deno.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"nodeModulesDir": "none",

"name": "@spacebudz/lucid",
"version": "0.20.2",
"version": "0.20.3",
"license": "MIT",
"exports": {
".": "./mod.ts",
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/overview/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you use Visual Studio Code, it's highly recommended to install the

## Using NPM/Node.js

Make sure you have [Node.js](https://nodejs.org/en/) >= 18 installed.
Make sure you have [Node.js](https://nodejs.org/en/) >= 20 installed.

Add Lucid to your project:

Expand Down
5 changes: 5 additions & 0 deletions mod.ts
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
/**
* This module contains all functions to Lucid.
* @module
*/

export * from "./src/mod.ts";

0 comments on commit 3e7cc54

Please sign in to comment.