Skip to content

chore: update some README code #1874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keithamus merged 1 commit into from
Oct 5, 2026
+8 −5
Merged

chore: update some README code #1874

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,10 @@ Chai is an _assertion library_, similar to Node's built-in `assert`. It makes te
You can also use it within the browser; install via npm and use the `index.js` file found within the download. For example:

```html
<script src="./node_modules/chai/index.js" type="module"></script>
<script type="module">
import { assert } from './node_modules/chai/index.js';
// ...
</script>
```

## Usage
Expand All @@ -79,9 +82,9 @@ import { should } from 'chai'; // Using Should style
### Register the chai testing style globally

```js
import 'chai/register-assert'; // Using Assert style
import 'chai/register-expect'; // Using Expect style
import 'chai/register-should'; // Using Should style
import 'chai/register-assert.js'; // Using Assert style
import 'chai/register-expect.js'; // Using Expect style
import 'chai/register-should.js'; // Using Should style
```

### Import assertion styles as local variables
Expand Down Expand Up @@ -133,7 +136,7 @@ Please make sure you follow our [Code Of Conduct](https://github.com/chaijs/chai

Here are a few issues other contributors frequently ran into when opening pull requests:

- Please do not commit changes to the `chai.js` build. We do it once per release.
- Please do not commit changes to the `index.js` build. We do it once per release.
- Before pushing your commits, please make sure you [rebase](https://github.com/chaijs/chai/blob/master/CONTRIBUTING.md#pull-requests) them.

### Contributors
Expand Down
Loading