diff --git a/README.md b/README.md index dc85e8b..c619965 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,9 @@ Full documentation available at [base64.56k.guru](https://base64.56k.guru) Node.js: `npm install @hexagon/base64 --save` -Deno (x): `import base64 from "https://deno.land/x/b64@1.1.28/src/base64.js";` +Deno (x): `import base64 from "https://deno.land/x/b64@2.0.0/src/base64.ts";` -Deno (jsr.io): `import base64 from "jsr:@hexagon/base64@1.1.28";` +Deno (jsr.io): `import base64 from "jsr:@hexagon/base64@2.0.0";` For browser/cdn usage, refer to the documentation. diff --git a/deno.json b/deno.json index 22f2454..02fc4e4 100644 --- a/deno.json +++ b/deno.json @@ -1,6 +1,6 @@ { "name": "@hexagon/base64", - "version": "2.0.0-dev.6", + "version": "2.0.0", "exports": "./src/base64.ts", "lint": { "include": ["src", "test", "build"] diff --git a/docs/contributing.md b/docs/contributing.md index 33a7f68..440bdca 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -42,15 +42,15 @@ We recommend using VS Code with eslint extensions. It will automatically check y - Using the command line: - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. -3. Install or update to **Node.js v16**. +3. Install or update to **Node.js v18**. 3. Create a working branch ```feature/my-cool-feature``` or ```bugfix/issue-14``` and start with your changes! ### Commit your update -Please run ```npm run build``` before committing, to update the dist-files, and to make sure that every test and check passes. +Please run ```deno task build``` before committing, to make sure that every test and check passes. -See [package.json](/package.json) scripts section for all available scripts. +See [deno.json](/deno.json) scripts section for all available scripts. Then, commit the changes once you are happy with them. @@ -66,4 +66,4 @@ Once you submit your PR, a team member will review your proposal. We may ask que ### Success! -This guide is based on [GitHub Docs CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) +This guide is based on [GitHub Docs CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) diff --git a/docs/installation.md b/docs/installation.md index 066116d..710d1e8 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -41,20 +41,20 @@ JavaScript: ```javascript // Deno.land/x -import base64 from "https://deno.land/x/b64@1.1.28/src/base64.js"; +import base64 from "https://deno.land/x/b64@2.0.0/src/base64.ts"; // ... or jsr.io -import base64 from "jsr:@hexagon/base64@1.1.28"; +import base64 from "jsr:@hexagon/base64@2.0.0"; ``` TypeScript: ``` // Deno.land/x -import { base64 } from "https://deno.land/x/b64@1.1.28/src/base64.js"; +import { base64 } from "https://deno.land/x/b64@2.0.0/src/base64.ts"; // ... or jsr.io -import { base64 } from "jsr:@hexagon/base64@1.1.28"; +import { base64 } from "jsr:@hexagon/base64@2.0.0"; ``` ### Browser @@ -63,21 +63,21 @@ import { base64 } from "jsr:@hexagon/base64@1.1.28"; - Download the latest [zipball](https://github.com/Hexagon/base64/archive/refs/heads/master.zip). - Unpack. -- Grab `base64.min.js` (UMD and standalone) or `base64.min.mjs` (ES-module) from the [dist/](/dist) folder. +- Grab `base64.umd.js` (UMD and standalone) or `base64.js` (ES-module) from the [dist/](/dist) folder. #### CDN For a [UMD](https://github.com/umdjs/umd)-module (standalone, [RequireJS](https://requirejs.org/), etc.): ```html - + ``` As an [ES-module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules): ```html ``` \ No newline at end of file