diff --git a/README.md b/README.md index 013f56e..7813642 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,8 @@ You can install it via `npm install axios`. Of course, any other compatible HTTP Node.js (Version 20 or later) to test & compile the TypeScript code to JavaScript. +### Install + First, install Node.js version 20. Then, install the NPM dependencies and execute the tests with the following commands: @@ -71,12 +73,12 @@ npm install npm test ``` +### How to add a feature + Every feature must be tested in the browser and in the node environment! Use a mainnet transaction to create a test scenario. The goal of this parser is to parse byte-perfect inscriptions that are identical to [ord](https://github.com/ordinals/ord). -### Steps - 1. **Fetch Transaction Test Data**: Save the raw transaction JSON to the `testdata` folder. ```bash npm run fetch-tx-testdata diff --git a/package.json b/package.json index ad52eee..dad56bc 100644 --- a/package.json +++ b/package.json @@ -47,6 +47,8 @@ }, "files": [ "dist", - "src" + "src", + "*.js", + "*.json" ] } diff --git a/src/index.spec.ts b/src/index.spec.ts deleted file mode 100644 index b390c06..0000000 --- a/src/index.spec.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { helloWorld } from "."; - -describe('Hello World', () => { - it('should work', () => { - expect(helloWorld).toBe('Hello World'); - }); -}); diff --git a/src/index.ts b/src/index.ts index 9d685ad..85f3def 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,3 +1,3 @@ export * from './inscription-parser.service'; +export * from './parsed-inscription'; -export const helloWorld = 'Hello World';