@mysten-incubation/devstack 0.0.0 → 0.0.1

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 (2) hide show
  1. package/README.md +17 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,12 +4,26 @@ Devstack composes a local Sui development environment from one TypeScript config
4
4
  fund accounts, publish Move packages, run the dev wallet, start app servers, wire services such as
5
5
  Walrus, Seal, and DeepBook, and generate typed files for app and test code.
6
6
 
7
- This package is still prototype-stage inside the monorepo and is not published to npm yet. The
8
- current docs live at <https://ts-sdks-incubation.vercel.app/devstack>.
7
+ The current docs live at <https://ts-sdks-incubation.vercel.app/devstack>.
9
8
 
10
9
  ## Quick Start
11
10
 
12
- Create a `devstack.config.ts` in your app:
11
+ Scaffold a new app from the canonical template:
12
+
13
+ ```bash
14
+ pnpm create @mysten-incubation/devstack-app my-app
15
+ cd my-app
16
+ pnpm dev
17
+ ```
18
+
19
+ Or add devstack to an existing app:
20
+
21
+ ```bash
22
+ pnpm add @mysten-incubation/devstack @mysten-incubation/dev-wallet @mysten/signers
23
+ pnpm add -D @mysten-incubation/tsconfig
24
+ ```
25
+
26
+ Then create a `devstack.config.ts` in your app:
13
27
 
14
28
  ```ts
15
29
  import { dirname, resolve } from 'node:path';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mysten-incubation/devstack",
3
- "version": "0.0.0",
3
+ "version": "0.0.1",
4
4
  "description": "Next-generation Sui devstack package.",
5
5
  "keywords": [
6
6
  "sui",
@@ -74,7 +74,7 @@
74
74
  "tsdown": "^0.21.10",
75
75
  "typescript": "^5.9.3",
76
76
  "vitest": "^4.1.6",
77
- "@mysten-incubation/tsconfig": "0.0.0"
77
+ "@mysten-incubation/tsconfig": "0.0.1"
78
78
  },
79
79
  "peerDependencies": {
80
80
  "vitest": "^4.1.6"