Skip to content

Commit

Permalink
Prepare 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Hexagon committed Oct 7, 2024
1 parent 1db953a commit dfd163b
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion deno.json
Original file line number Diff line number Diff line change
@@ -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"]
Expand Down
8 changes: 4 additions & 4 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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)
14 changes: 7 additions & 7 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
<script src="https://cdn.jsdelivr.net/npm/@hexagon/base64@1/dist/base64.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@hexagon/base64@2/dist/base64.umd.js"></script>
```

As an [ES-module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules):

```html
<script type="module">
import base64 from "https://cdn.jsdelivr.net/npm/@hexagon/base64@1/dist/base64.min.mjs";
import base64 from "https://cdn.jsdelivr.net/npm/@hexagon/base64@2/dist/base64.js";
// ... see 'Usage' section ...
</script>
```

0 comments on commit dfd163b

Please sign in to comment.