Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

Commit

Permalink
feat: update readme (#7)
Browse files Browse the repository at this point in the history
* fix(readme): relative reference to a package

* fix(readme): remove extraneous baseUrl override

* feat(readme): explain basic defaults overrides

* feat(readme): provide more usage examples

* chore(cspell): fix unknown spelling
  • Loading branch information
mv-go authored Apr 26, 2022
1 parent 1d183f0 commit 31b1d90
Show file tree
Hide file tree
Showing 3 changed files with 365 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ npm i @tzkt/<package_name>

| Name | Description | NPM |
| ------------------- | -------------------------------- | -------------------------------------------------------------- |
| [@tzkt/sdk-api](https://github.com/tzkt/api-sdk-ts/tree/main/packages/sdk-api) | Wrappers for TzKT API endpoints written in TS | |
| [@tzkt/sdk-api](packages/sdk-api/README.md) | Wrappers for TzKT API endpoints written in TS | |

## Contributing and publishing

Expand Down
14 changes: 8 additions & 6 deletions packages/sdk-api/.cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
"language": "en",
"words": [
"annots",
"anyof",
"Atomex",
"bigmap",
"bigmaps",
"bitauth",
Expand All @@ -17,6 +19,7 @@
"Delegators",
"dependabot",
"editorconfig",
"entrypoint",
"entrypoints",
"esnext",
"execa",
Expand All @@ -26,8 +29,12 @@
"micheline",
"mkdir",
"oazapfts",
"OBJKT",
"openapi",
"originations",
"preendorsement",
"preendorsements",
"preendorsing",
"prettierignore",
"sandboxed",
"supermajority",
Expand All @@ -37,12 +44,7 @@
"tzkt",
"untracked",
"upvoted",
"upvotes",
"preendorsing",
"entrypoint",
"anyof",
"preendorsement",
"preendorsements"
"upvotes"
],
"flagWords": [],
"ignorePaths": [
Expand Down
Loading

0 comments on commit 31b1d90

Please sign in to comment.