update to v0.9.1.
add npm package link prep for jsr support (I hope) add favicon update installation instructions
This commit is contained in:
21
README.md
21
README.md
@@ -14,25 +14,28 @@ These functions include:
|
||||
|
||||
## Installation
|
||||
|
||||
Browser
|
||||
This library can be installed in several different ways:
|
||||
|
||||
- Download [library](/dist-browser/twtxt-lib.js) (or [minified version](/dist-browser/twtxt-lib.min.js)).
|
||||
- Import desired function(s) into your project: `import { hashTwt, loadAndParseTwtxtFile } from "./twtxt-lib.js"`
|
||||
### For the Browser
|
||||
|
||||
NPM
|
||||
1. Grab the latest copy of the `twtxt-lib.js` file, either by downloading it from the [git repo](https://git.itsericwoodward.com/eric/twtxt-lib/raw/branch/main/dist-browser/twtxt-lib.js), the [website](https://twtxt-lib.itsericwoodward.com/dist-browser/twtxt-lib.js), or doing a `git clone https://git.itsericwoodward.com/eric/twtxt-lib.git` and pulling it out of the `dist-browser` folder.
|
||||
- Alternatively, you can grab the minified version from the [same](https://git.itsericwoodward.com/eric/twtxt-lib/raw/branch/main/dist-browser/twtxt-lib.min.js) [sources](https://twtxt-lib.itsericwoodward.com/dist-browser/twtxt-lib.min.js).
|
||||
2. Add the newly acquired file to your static site / progressive web app / over-engineered blog.
|
||||
3. Import the desired function(s) via ESM: `import { hashTwt, loadAndParseTwtxtFile } from "./twtxt-lib.js";`
|
||||
|
||||
- Coming soon
|
||||
### For Node
|
||||
|
||||
JSR
|
||||
|
||||
- Coming soon
|
||||
1. Add the package to your project.
|
||||
- Via [NPM](https://www.npmjs.com/package/twtxt-lib): `yarn add twtxt-lib`
|
||||
- Via [JSR](https://jsr.io/@itsericwoodward/twtxt-lib): `yarn add jsr:@itsericwoodward/twtxt-lib`
|
||||
2. Import the desired function(s) into your code: `import { hashTwt, loadAndParseTwtxtFile } from "twtxt-lib";`
|
||||
|
||||
## Features
|
||||
|
||||
- Isomorphic, available as an ([optionally minified](/dist-browser/twtxt-lib.min.js))
|
||||
[ES6+ library for the browser](/dist-browser/twtxt-lib.js), with NPM and JSR versions coming soon.
|
||||
- Fully typed and source-mapped.
|
||||
- [ESM](https://caniuse.com/es6-module) (and [ESM only](https://antfu.me/posts/move-on-to-esm-only)).
|
||||
- [ES6 Module](https://caniuse.com/es6-module) (and [ESM only](https://antfu.me/posts/move-on-to-esm-only)).
|
||||
- Includes sample files and an [interactive demo page](https://twtxt-lib.itsericwoodward.com/).
|
||||
|
||||
## Usage
|
||||
|
||||
Reference in New Issue
Block a user