Skip to content

Commit

Permalink
Update documentation and bump version (#132)
Browse files Browse the repository at this point in the history
* Update docs, remove contributing

* Bump version to v4.0
  • Loading branch information
jgarber623 authored Oct 15, 2023
1 parent ca3f086 commit f9b93a8
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 69 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Changelog

# 4.0.0 (2023-10-14)

- ca3f086 Minor cleanup (#131)
- 9261dcd Add JSDoc to source file (#130)
- 4a17935 Add concurrently and http-server (#129)
- e77cbc6 Migrate test suite to AVA (#128)
- e426517 Chore: Address linting issues (#127)
- dce6c89 Breaking: Convert project to ESM (#126)
- b84eb4c Remove and ignore `./dist` folder (#125)
- dea8917 Refactor GitHub Actions (#120)
- b4365c6 Specify LTS branch in nvm config file (#119)
- 9d0e56a Remove CodeClimate badge (#118)
55 changes: 0 additions & 55 deletions CONTRIBUTING.md

This file was deleted.

14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@

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

## Getting CashCash

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

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

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

## Browser Support

CashCash works in modern browsers. The library makes use of several new(ish) JavaScript features, including:

- Arrow function expressions ([MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions))
- Classes ([MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes))
- Template literals ([MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals))
- `Document.querySelectorAll()` ([MDN](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll))
- `NodeList.prototype.forEach` ([MDN](https://developer.mozilla.org/en-US/docs/Web/API/NodeList/forEach))

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.
**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.

## Acknowledgments

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jgarber/cashcash",
"version": "3.0.0",
"version": "4.0.0",
"description": "A very small DOM library inspired by jQuery.",
"keywords": [
"dom",
Expand Down

0 comments on commit f9b93a8

Please sign in to comment.