@settlemint/sdk-cli 0.8.6-pre24e2f89 → 0.8.6-predc2ddfc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +23 -30
  2. package/dist/cli.js +45535 -45595
  3. package/dist/cli.js.map +43 -44
  4. package/package.json +8 -6
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  Integrate SettleMint into your application with ease.
8
8
  </p>
9
9
  </p>
10
- <br/>
10
+
11
11
  <p align="center">
12
12
  <a href="https://github.com/settlemint/sdk/actions?query=branch%3Amain"><img src="https://github.com/settlemint/sdk/actions/workflows/build.yml/badge.svg?event=push&branch=main" alt="CI status" /></a>
13
13
  <a href="https://fsl.software" rel="nofollow"><img src="https://img.shields.io/npm/l/@settlemint/sdk-cli" alt="License"></a>
@@ -26,45 +26,38 @@
26
26
  <br />
27
27
  </div>
28
28
 
29
- ## Getting started
30
-
31
- First we will create a new Next JS project using the following command.
29
+ ## Table of Contents
32
30
 
33
- ```bash
34
- # Using npx
35
- npx @settlemint/sdk-cli@latest create
31
+ - [About](#about)
32
+ - [Usage](#usage)
33
+ - [API Reference](#api-reference)
34
+ - [Contributing](#contributing)
35
+ - [License](#license)
36
36
 
37
- # Using bun
38
- bunx @settlemint/sdk-cli@latest create
37
+ ## About
39
38
 
40
- # Using pnpm
41
- pnpm dlx @settlemint/sdk-cli@latest create
42
- ```
39
+ The SettleMint CLI provides a command-line interface for interacting with the SettleMint platform. It enables you to manage your blockchain networks, deploy smart contracts, configure your SettleMint infrastructure directly from the terminal.
43
40
 
44
- Then following the next steps in your terminal.
41
+ ## Usage
45
42
 
43
+ TODO: define default
46
44
 
47
- ## Local development
45
+ ## API Reference
48
46
 
49
- ### Debugging
47
+ See the [documentation](./docs/settlemint.md) for available commands.
50
48
 
51
- To debug with interactive input you need to start the command from the terminal and then attach the debugger.
49
+ ## Contributing
52
50
 
53
- ```bash
54
- bun --inspect-wait=localhost:6499/ sdk/cli/src/cli.ts create
55
- # Attach the debugger using the "SDK: Attach to process" configuration
51
+ We welcome contributions to the SettleMint SDK! If you'd like to contribute, please follow these steps:
56
52
 
57
- # Run from the directory created by the create command
58
- bun --inspect-wait=localhost:6499/ sdk/cli/src/cli.ts connect
59
- # Attach the debugger using the "SDK: Attach to process" configuration
60
- ```
53
+ 1. Fork the repository
54
+ 2. Create a new branch for your feature or bug fix
55
+ 3. Make your changes and commit them with a clear commit message
56
+ 4. Push your changes to your fork
57
+ 5. Create a pull request to the main repository
61
58
 
62
- ### e2e tests
59
+ Please ensure that your code follows the existing style and includes appropriate tests and documentation.
63
60
 
64
- Create a ".env" file in the root folder of this project.
61
+ ## License
65
62
 
66
- ```env
67
- SETTLEMINT_ACCESS_TOKEN_E2E_TESTS="sm_pat_xxx"
68
- SETTLEMINT_INSTANCE="https://me.settlemint.be"
69
- DISABLE_WORKSPACE_DELETE=true
70
- ```
63
+ The SettleMint SDK is released under the [FSL Software License](https://fsl.software). See the [LICENSE](LICENSE) file for more details.