Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit f9b93a8

Browse files
authored
Update documentation and bump version (#132)
* Update docs, remove contributing * Bump version to v4.0
1 parent ca3f086 commit f9b93a8

File tree

5 files changed

+20
-69
lines changed

5 files changed

+20
-69
lines changed

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
3+
# 4.0.0 (2023-10-14)
4+
5+
- ca3f086 Minor cleanup (#131)
6+
- 9261dcd Add JSDoc to source file (#130)
7+
- 4a17935 Add concurrently and http-server (#129)
8+
- e77cbc6 Migrate test suite to AVA (#128)
9+
- e426517 Chore: Address linting issues (#127)
10+
- dce6c89 Breaking: Convert project to ESM (#126)
11+
- b84eb4c Remove and ignore `./dist` folder (#125)
12+
- dea8917 Refactor GitHub Actions (#120)
13+
- b4365c6 Specify LTS branch in nvm config file (#119)
14+
- 9d0e56a Remove CodeClimate badge (#118)

CONTRIBUTING.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010

1111
- Uses JavaScript's native [`querySelectorAll`](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll) method
1212
- Dependency-free
13-
- ES2015/AMD/Node module support
13+
- JavaScript module (ESM), CommonJS, and browser global (`window.TemplateTemplate`) support
1414

1515
## Getting CashCash
1616

1717
You've got a couple options for adding CashCash to your project:
1818

19-
- [Download a tagged version](https://github.com/jgarber623/CashCash/tags) from GitHub and do it yourself _(old school)_.
19+
- [Download a release](https://github.com/jgarber623/CashCash/releases) from GitHub and do it yourself _(old school)_.
2020
- Install using [npm](https://www.npmjs.com/package/@jgarber/cashcash): `npm install @jgarber/cashcash --save`
2121
- Install using [Yarn](https://yarnpkg.com/en/package/@jgarber/cashcash): `yarn add @jgarber/cashcash`
2222

@@ -128,15 +128,7 @@ If you want to cut down on some typing (and potentially confuse your teammates),
128128

129129
## Browser Support
130130

131-
CashCash works in modern browsers. The library makes use of several new(ish) JavaScript features, including:
132-
133-
- Arrow function expressions ([MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions))
134-
- Classes ([MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes))
135-
- Template literals ([MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals))
136-
- `Document.querySelectorAll()` ([MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll))
137-
- `NodeList.prototype.forEach` ([MDN](https://developer.mozilla.org/en-US/docs/Web/API/NodeList/forEach))
138-
139-
CashCash, in an effort to remain as lightweight and dependency-free as possible, leaves it up to you to choose whether or not to polyfill features for older browsers.
131+
**CashCash works in modern browsers.** The library makes use of several new(ish) JavaScript features and, in an effort to remain as lightweight and dependency-free as possible, leaves it up to you to choose whether or not to polyfill features for older browsers.
140132

141133
## Acknowledgments
142134

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@jgarber/cashcash",
3-
"version": "3.0.0",
3+
"version": "4.0.0",
44
"description": "A very small DOM library inspired by jQuery.",
55
"keywords": [
66
"dom",

0 commit comments

Comments
 (0)