Skip to content

Commit

Permalink
format
Browse files Browse the repository at this point in the history
  • Loading branch information
pngwn committed Aug 21, 2024
1 parent 00ae540 commit 185dede
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 64 deletions.
97 changes: 47 additions & 50 deletions packages/template/README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,47 @@

# Default Template

This is a template that leverages the experimental templates feature in the `pkg.pr.new` tool.

## Overview

Templates are particularly useful for creating live, interactive examples of your packages, which can be very beneficial for both development and documentation purposes.

As a user, you can check the package.json file and see the new generated packages! You can just copy those and put them in your package.json or install them with your favorite package manager.


```sh
npm i https://pkg.pr.new/pngwn/MDsveX/mdsvex@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/pfm-parse@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svast@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svast-stringify@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svast-utils@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svelte-parse@e9631f1
```


## Usage

To use this feature as a maintainer, you can run the following command:

```sh
npx pkg-pr-new publish './packages/A' --template './examples/*'
```

## Benefits

- Interactive Demos: Automatically create live demos that users can interact with directly in their browser.
- Enhanced Testing: Quickly spin up environments to test your package in different scenarios.
- Improved Sharing: Easily share working examples of your package with collaborators or users without needing them to set up their environment.
# Default Template

This is a template that leverages the experimental templates feature in the `pkg.pr.new` tool.

## Overview

Templates are particularly useful for creating live, interactive examples of your packages, which can be very beneficial for both development and documentation purposes.

As a user, you can check the package.json file and see the new generated packages! You can just copy those and put them in your package.json or install them with your favorite package manager.

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/mdsvex@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/pfm-parse@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svast@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svast-stringify@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svast-utils@e9631f1
```

```sh
npm i https://pkg.pr.new/pngwn/MDsveX/svelte-parse@e9631f1
```

## Usage

To use this feature as a maintainer, you can run the following command:

```sh
npx pkg-pr-new publish './packages/A' --template './examples/*'
```

## Benefits

- Interactive Demos: Automatically create live demos that users can interact with directly in their browser.
- Enhanced Testing: Quickly spin up environments to test your package in different scenarios.
- Improved Sharing: Easily share working examples of your package with collaborators or users without needing them to set up their environment.
28 changes: 14 additions & 14 deletions packages/template/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "mdsvex-test",
"version": "1.0.0",
"description": "generated by pkg.pr.new",
"main": "index.js",
"dependencies": {
"mdsvex": "workspace:*"
},
"keywords": [],
"author": "pkg.pr.new",
"license": "ISC",
"private": "true",
"type": "module"
}
{
"name": "mdsvex-test",
"version": "1.0.0",
"description": "generated by pkg.pr.new",
"main": "index.js",
"dependencies": {
"mdsvex": "workspace:*"
},
"keywords": [],
"author": "pkg.pr.new",
"license": "ISC",
"private": "true",
"type": "module"
}

0 comments on commit 185dede

Please sign in to comment.