@uge/payo 0.1.6 → 0.1.7
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 +31 -1
- package/assets/demo.gif +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,6 +13,10 @@ project's conventions instead of guessing.
|
|
|
13
13
|
[](https://bun.sh)
|
|
14
14
|
[](https://www.typescriptlang.org/)
|
|
15
15
|
|
|
16
|
+
<br />
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
16
20
|
</div>
|
|
17
21
|
|
|
18
22
|
---
|
|
@@ -29,6 +33,7 @@ project's conventions instead of guessing.
|
|
|
29
33
|
- [Bootstrap prompt](#bootstrap-prompt)
|
|
30
34
|
- [Resume anytime](#resume-anytime)
|
|
31
35
|
- [Requirements](#requirements)
|
|
36
|
+
- [Run locally](#run-locally)
|
|
32
37
|
- [Contributing](#contributing)
|
|
33
38
|
- [License](#license)
|
|
34
39
|
|
|
@@ -161,7 +166,32 @@ generating what's missing. Finished runs clean the directory up automatically.
|
|
|
161
166
|
|
|
162
167
|
## Requirements
|
|
163
168
|
|
|
164
|
-
|
|
169
|
+
**To run Payo:** [Node.js](https://nodejs.org) **>= 18**. That's it — `npx @uge/payo`
|
|
170
|
+
runs the published, Node-targeted binary, so **you do not need Bun to use Payo.**
|
|
171
|
+
If you prefer Bun, `bunx @uge/payo` works too.
|
|
172
|
+
|
|
173
|
+
**To develop Payo:** [Bun](https://bun.sh) **>= 1.1.0** (the project builds, tests,
|
|
174
|
+
and runs from source with Bun — see [Run locally](#run-locally)).
|
|
175
|
+
|
|
176
|
+
## Run locally
|
|
177
|
+
|
|
178
|
+
Hacking on Payo or running it from source:
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
git clone https://github.com/uttam-gelot/payo.git
|
|
182
|
+
cd payo
|
|
183
|
+
bun install # Bun >= 1.1.0
|
|
184
|
+
bun run dev # runs src/index.ts directly
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Other useful scripts:
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
bun test # run the test suite
|
|
191
|
+
bun run typecheck # tsc --noEmit
|
|
192
|
+
bun run lint # eslint
|
|
193
|
+
bun run build # bundle to dist/ (Node target)
|
|
194
|
+
```
|
|
165
195
|
|
|
166
196
|
## Contributing
|
|
167
197
|
|
package/assets/demo.gif
ADDED
|
Binary file
|