Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update README #32

Merged
merged 1 commit into from
Oct 2, 2021
Merged

chore: update README #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 1 addition & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,4 @@
# eszip

A utility that can download JavaScript and TypeScript module graphs and store
A library that can download JavaScript and TypeScript module graphs and store
them locally in a special zip file.

To create a new archive:
```
> eszip get https://raw.githubusercontent.com/satyarohith/kament/main/mod.ts
Download https://raw.githubusercontent.com/satyarohith/kament/main/mod.ts
...
Wrote es.zip
```

To print the list of modules in an eszip file:
```
> eszip list es.zip
https://denopkg.com/chiefbiiko/sha512/mod.ts
https://deno.land/x/djwt@v2.1/algorithm.ts
https://deno.land/x/god_crypto@v1.4.8/src/rsa/rsa_key.ts
https://deno.land/x/god_crypto@v1.4.8/src/rsa/rsa_js.ts
...
```

To read a module from the archive:
```
> eszip read es.zip https://denopkg.com/chiefbiiko/sha512/mod.ts
import { encode, decode } from "./deps.ts";

/** Byte length of a SHA512 hash. */
export const BYTES: number = 64;

/** A class representation of the SHA2-512 algorithm. */
export class SHA512 {
readonly hashSize: number = BYTES;
...
```