diff --git a/README.md b/README.md index 9238b2c81..bb4f965d5 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,17 @@ ## Just +[API](#the-modules-package) | +[Try It](#try-icecream) | +[Read](#read-books) | +[Testing](#testing) | +[Contribute!](https://github.com/angus-c/just/blob/master/CONTRIBUTING.md) | + A library of **zero-dependency** npm modules that do just one thing. A guilt-free alternative to those bulkier utility libraries. Ideal for PWA development or whenever bytes are precious. ![Build status](https://github.com/angus-c/just/actions/workflows/node.js.yml/badge.svg) -**[Jump To API](#the-modules-package)** - We welcome contributions. Please follow our [contribution guidelines](https://github.com/angus-c/just/blob/master/CONTRIBUTING.md). ## Try :icecream: diff --git a/templates/global.template b/templates/global.template index 8a3336f82..65c0d744c 100644 --- a/templates/global.template +++ b/templates/global.template @@ -1,12 +1,16 @@ ## Just +[API](#the-modules-package) | +[Try It](#try-icecream) | +[Read](#read-books) | +[Testing](#testing) | +[Contribute!](https://github.com/angus-c/just/blob/master/CONTRIBUTING.md) | + A library of **zero-dependency** npm modules that do just one thing. A guilt-free alternative to those bulkier utility libraries. Ideal for PWA development or whenever bytes are precious. ![Build status](https://github.com/angus-c/just/actions/workflows/node.js.yml/badge.svg) -**[Jump To API](#the-modules-package)** - We welcome contributions. Please follow our [contribution guidelines](https://github.com/angus-c/just/blob/master/CONTRIBUTING.md). ## Try :icecream: @@ -35,18 +39,15 @@ const clone = require('just-clone'); ``` ## TypeScript -We're in the process of adding TypeScript definitions and tests to every Just utility. You're welcome to help us get there! -[Here's](https://github.com/angus-c/just/pull/247/files) an example PR. - -You can verify new TypeScript definitions by running `yarn test-types` (This also gets run as part of the `yarn test` script) +We've now added TypeScript definitions and tests for every Just utility -## Browser Support :computer: +## Browser/Platform Support :computer: -Data based on [available saucelabs test browsers](https://github.com/angus-c/just/tree/sauce). It's likely _Just_ is also fully supported by some older versions not verifiable via saucelabs. +Most utilities still work with any platform that supports ES5, but these are the earliest guaranteed versions across _every_ utility. For guidance any platform that supports [spread in array literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax#spread_in_array_literals) will work with Just. -| Chrome | Safari | Firefox | Edge | Node | Mobile Safari | Android | +| Chrome | Safari | Firefox | Edge | Node | Mobile Safari | Android Chrome | | ------ | ------ | ------- | ---- | ---- | ------------- | ------------- | -| yes | yes | yes | 12 | 6+ | iOS 8+ | Android OS 5+ | +| 46 | 8 | 16 | 12 | 6.0 | 8 | 46 | ## The Modules :package: