pi-character 0.1.0 → 0.1.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.
- package/README.md +22 -11
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -12,10 +12,10 @@ no custom Pi build or additional runtime dependencies are needed.
|
|
|
12
12
|
|
|
13
13
|
## Quick start
|
|
14
14
|
|
|
15
|
-
Install
|
|
15
|
+
Install the published package from npm:
|
|
16
16
|
|
|
17
17
|
```sh
|
|
18
|
-
pi install
|
|
18
|
+
pi install npm:pi-character
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Restart Pi or run `/reload`. **Cray the Crawfish** appears alongside Pi's original startup header.
|
|
@@ -29,9 +29,6 @@ Open the character menu:
|
|
|
29
29
|
Choose **Choose character**, then use **↑ / ↓** to preview the animations. Press **Enter** to save
|
|
30
30
|
your choice, or **Escape** to return to your previous character.
|
|
31
31
|
|
|
32
|
-
The package is not published to npm yet. Once published, installation will be
|
|
33
|
-
`pi install npm:pi-character`.
|
|
34
|
-
|
|
35
32
|
## Meet the characters
|
|
36
33
|
|
|
37
34
|
Five characters are included and ready to use:
|
|
@@ -153,10 +150,8 @@ out of the picker across restarts, including bundled presets.
|
|
|
153
150
|
|
|
154
151
|
## Uninstall
|
|
155
152
|
|
|
156
|
-
For an installation from a local checkout:
|
|
157
|
-
|
|
158
153
|
```sh
|
|
159
|
-
pi remove
|
|
154
|
+
pi remove npm:pi-character
|
|
160
155
|
```
|
|
161
156
|
|
|
162
157
|
Your saved characters and preferences remain. To reset them as well, separately delete the
|
|
@@ -171,14 +166,21 @@ npm ci --legacy-peer-deps
|
|
|
171
166
|
npm run build
|
|
172
167
|
```
|
|
173
168
|
|
|
174
|
-
To load the checkout for a single Pi session
|
|
169
|
+
To load the checkout for a single Pi session:
|
|
175
170
|
|
|
176
171
|
```sh
|
|
177
172
|
pi -e /path/to/pi-character
|
|
178
173
|
```
|
|
179
174
|
|
|
180
|
-
|
|
181
|
-
|
|
175
|
+
To install a local checkout instead, use its absolute path:
|
|
176
|
+
|
|
177
|
+
```sh
|
|
178
|
+
pi install /path/to/pi-character
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
Remove a local installation with `pi remove /path/to/pi-character`. Pass the package directory so
|
|
182
|
+
Pi reads its manifest and loads only `src/index.ts`. Use one loading method at a time: npm, local
|
|
183
|
+
installation, or `-e`.
|
|
182
184
|
|
|
183
185
|
### Project layout
|
|
184
186
|
|
|
@@ -237,4 +239,13 @@ Run `npm pack --dry-run` or `npm pack` to review release contents. Packing runs
|
|
|
237
239
|
the package includes source, presets, demo media, README, and license. Asset paths resolve relative to the
|
|
238
240
|
extension module, so playback works from any working directory.
|
|
239
241
|
|
|
242
|
+
### Release
|
|
243
|
+
|
|
244
|
+
```sh
|
|
245
|
+
npm run release
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Checks the package, bumps the patch version, and asks before publishing to npm.
|
|
249
|
+
Run `npm run release -- --help` for options.
|
|
250
|
+
|
|
240
251
|
Licensed under [MIT](LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pi-character",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Animated ASCII companions for your Pi terminal. Pick a bundled character or generate your own.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -34,7 +34,8 @@
|
|
|
34
34
|
"build": "npm run check && npm test",
|
|
35
35
|
"prepack": "npm run build",
|
|
36
36
|
"test": "node --test test/*.test.ts",
|
|
37
|
-
"test:smoke": "node test/smoke.ts --source"
|
|
37
|
+
"test:smoke": "node test/smoke.ts --source",
|
|
38
|
+
"release": "node scripts/update-npm.ts"
|
|
38
39
|
},
|
|
39
40
|
"overrides": {
|
|
40
41
|
"@earendil-works/pi-coding-agent": {
|