Skip to content

Commit

Permalink
remove minified bundle / add jsr to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dbushell committed Feb 15, 2024
1 parent fe3da02 commit 7970d6f
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 45 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 David Bushell
Copyright (c) 2024 David Bushell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Fetch and parse XML documents using the power of JavaScript web streams and asyn

See the `examples` directory for platform specific examples.

```javascript
import {parse} from "jsr:@dbushell/[email protected]";
```

The `parse` generator function is the main export. Below is a basic example that logs RSS item titles as they're found:

```javascript
Expand Down Expand Up @@ -51,6 +55,20 @@ Browsers may need a [polyfill](https://bugs.chromium.org/p/chromium/issues/detai

‡ Bun has issues ([#2489](https://github.com/oven-sh/bun/issues/2489))

## NPM

Add the [JavaScript Registry](https://jsr.io/) to `.npmrc`:

```
@jsr:registry=https://npm.jsr.io
```

Install the package:

```sh
npm install @jsr/dbushell__xml-streamify
```

* * *

[MIT License](/LICENSE) | Copyright © 2023 [David Bushell](https://dbushell.com)
[MIT License](/LICENSE) | Copyright © 2024 [David Bushell](https://dbushell.com)
2 changes: 1 addition & 1 deletion deno.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@dbushell/xml-streamify",
"version": "0.2.0",
"version": "0.2.1",
"exports": {
".": "./mod.ts",
"./node": "./src/node.ts",
Expand Down
5 changes: 3 additions & 2 deletions examples/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/*
!.gitignore
!advanced
!*.ts
!*.mjs
advanced/**.*
!**/*.ts
!**/*.mjs
4 changes: 0 additions & 4 deletions examples/advanced/.gitignore

This file was deleted.

22 changes: 0 additions & 22 deletions examples/advanced/bundle.ts

This file was deleted.

10 changes: 0 additions & 10 deletions examples/advanced/deno.json

This file was deleted.

2 changes: 1 addition & 1 deletion examples/advanced/mod.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import * as html from 'https://deno.land/std@0.204.0/html/mod.ts';
import * as html from 'https://deno.land/std@0.216.0/html/mod.ts';
import {serverURL, serverController} from './server.ts';
import {parse} from '../../mod.ts';

Expand Down
2 changes: 1 addition & 1 deletion examples/deno.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env -S deno run --allow-net

import {parse, Node} from '../mod.ts';
import {parse, Node} from 'jsr:@dbushell/[email protected]';

const blog = async () => {
const parser = parse('https://dbushell.com/rss.xml');
Expand Down
2 changes: 1 addition & 1 deletion examples/node.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env -S node

import {parse} from '../mod.min.mjs';
import {parse} from '@jsr/dbushell__xml-streamify';

const blog = async () => {
const parser = parse('https://dbushell.com/rss.xml');
Expand Down
1 change: 0 additions & 1 deletion mod.min.mjs

This file was deleted.

0 comments on commit 7970d6f

Please sign in to comment.