Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
karmaniverous committed Dec 22, 2022
1 parent 75f303a commit 76f7706
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
You wrote a sweet piece of code! Releasing it on [NPM](https://www.npmjs.com/)
seems like the obvious next step. Right?

Try it. Not as easy to do from scratch as you might think.
_Try it!_ Not as easy to do as you might think. At high quality. From scratch.

So here's a plug-and-play NPM package template that offers the following
features:

- Support for the latest ES6 goodies with
- Tree-shakable support for the latest ES6 goodies with
[`eslint`](https://www.npmjs.com/package/eslint) _uber alles_.

- A command line interface for your widget with
- CJS distributions targeting specific browser support scenarios.

- Command line interfaces for your widget with
[`commander`](https://www.npmjs.com/package/commander).

- Automated [`lodash`](https://www.npmjs.com/package/lodash) cherry-picking with
Expand All @@ -21,7 +23,9 @@ features:
[`chai`](https://www.npmjs.com/package/chai) for testing, with examples, and a
sweet testing console.

- Secure environment-variable access to [`package.json`](./package.json) data.
- In-code access to
[`package.json`](https://github.com/karmaniverous/npm-package-template/blob/main/package.json)
data, with no warnings to ignore.

- Code formatting at every save & paste with
[`prettier`](https://www.npmjs.com/package/prettier).
Expand Down
12 changes: 8 additions & 4 deletions doc/1-main.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
You wrote a sweet piece of code! Releasing it on [NPM](https://www.npmjs.com/)
seems like the obvious next step. Right?

Try it. Not as easy to do from scratch as you might think.
_Try it!_ Not as easy to do as you might think. At high quality. From scratch.

So here's a plug-and-play NPM package template that offers the following
features:

- Support for the latest ES6 goodies with
- Tree-shakable support for the latest ES6 goodies with
[`eslint`](https://www.npmjs.com/package/eslint) _uber alles_.

- A command line interface for your widget with
- CJS distributions targeting specific browser support scenarios.

- Command line interfaces for your widget with
[`commander`](https://www.npmjs.com/package/commander).

- Automated [`lodash`](https://www.npmjs.com/package/lodash) cherry-picking with
Expand All @@ -21,7 +23,9 @@ features:
[`chai`](https://www.npmjs.com/package/chai) for testing, with examples, and a
sweet testing console.

- Secure environment-variable access to [`package.json`](./package.json) data.
- In-code access to
[`package.json`](https://github.com/karmaniverous/npm-package-template/blob/main/package.json)
data, with no warnings to ignore.

- Code formatting at every save & paste with
[`prettier`](https://www.npmjs.com/package/prettier).
Expand Down

0 comments on commit 76f7706

Please sign in to comment.