-
Notifications
You must be signed in to change notification settings - Fork 118
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.
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
2945 readme 0509 #2955
2945 readme 0509 #2955
Changes from 34 commits
81f82f7
eab82bb
0259cdd
b1a2679
45223bd
a82b5cd
3b08821
bfd1f49
5d0a7cc
7b9d4c1
37e14e4
dc68be9
f259810
6fdda51
298b413
06af53b
e4853cf
fc2e2b0
a64564e
ae561ab
0a2974b
708d150
e018e9e
4523ffb
3c386ad
dffb59c
b58a460
8fa69af
a896a23
fd47258
00892e8
a39aaa5
82f5a89
0f41235
1f7a1a6
fe3398d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,10 +11,6 @@ Welcome, Web3 developer! | |
|
||
Taquito is a fast and lightweight [TypeScript](https://www.typescriptlang.org/) library to accelerate DApp development on the [Tezos](https://tezos.com/developers) blockchain. With it, you can easily interact with Smart Contracts deployed to Tezos. It is distributed as a suite of individual `npm` packages, to reduce bloat and improve application startup times. | ||
|
||
## What about Smart Contract Development? | ||
|
||
If you are a current or aspiring "full-stack" blockchain developer, be sure to check out Taquito's sister project [Taqueria](https://taqueria.io). Taqueria is a Developer Tool Suite with *rich support* for Smart Contract development and orchestration on Tezos, and fully compliments Taquito. | ||
|
||
## What is Included in Taquito? | ||
|
||
Taquito is primarily targeted at Front-End Web3 developers, so it comes with batteries included, such as a [React Template Project](https://github.com/ecadlabs/taquito-react-template), an extensible framework, and many helpful utilities. It can be used in *many* execution contexts, including Serverless, Node.js, Deno, and Electron (to name a few) and has minimal dependencies. | ||
|
@@ -45,11 +41,9 @@ Taquito currently supports the following versions of Node.js®: | |
| ---------------- | ---------- | | ||
| v12 LTS | ❌ | | ||
| v14 LTS | ❌ | | ||
| v16.13.1 | ❌ | | ||
| v16 LTS/Gallium | ❌ | | ||
| 17.3.x | ❌ | | ||
| v18 LTS/Hydrogen | ✅ | | ||
| v20 | ✅ | | ||
| v20 LTS/Iron | ✅ | | ||
|
||
While other versions often work, the above are what we officially support. YMMV! | ||
|
||
|
@@ -64,27 +58,34 @@ We are active and enthusiastic participants of the following community support c | |
|
||
Taquito is organized as a [monorepo](https://en.wikipedia.org/wiki/Monorepo), and is composed of several npm packages that are [published to npmjs.org](https://www.npmjs.com/package/@taquito/taquito) under the `@taquito` handle. Each package has its own README which can be found in the corresponding directory within `packages/`. | ||
|
||
| High-Level Packages | Responsibility | | ||
| -------------------------------------------------------------- | ------------------------------------------------------------ | | ||
| High-Level Packages | Responsibility | | ||
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | ||
| [@taquito/taquito](packages/taquito) | [Facade](https://en.wikipedia.org/wiki/Facade_pattern) to lower-level, package-specific functionality | | ||
|
||
| Low-Level Packages | Responsibility | | ||
| ---------------------------------------------------------------- | ------------------------------------------------------------- | | ||
| [@taquito/local-forging](packages/taquito-local-forging) | Local "forging": serialization of Tezos operations as bytes | | ||
| [@taquito/michelson-encoder](packages/taquito-michelson-encoder) | Creates JS abstractions of Smart Contracts | | ||
| [@taquito/michel-codec](packages/taquito-michel-codec) | Converts Michelson between forms, expands Macros, etc | | ||
| [@taquito/remote-signer](packages/taquito-remote-signer) | Provides the facility to use a remote signer, such as https://signatory.io | | ||
| [@taquito/rpc](packages/taquito-rpc) | RPC client library: every rpc endpoint has its own method | | ||
| [@taquito/signer](packages/taquito-signer) | Provides functionality to sign data using tezos keys | | ||
| [@taquito/utils](packages/taquito-utils) | Provides different encoding and decoding utilities | | ||
| [@taquito/tzip12](packages/taquito-tzip12) | TZIP-12 allows retrieving NFT/token metadata | | ||
| [@taquito/tzip16](packages/taquito-tzip16) | TZIP-16 allows retrieving contract metadata and executing off-chain views | | ||
| [@taquito/beacon-wallet](packages/taquito-beacon-wallet) | TZIP-10 implementation of a Wallet API | | ||
| Low-Level Packages | Responsibility | | ||
| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | ||
| [@taquito/local-forging](packages/taquito-local-forging) | Local "forging": serialization of Tezos operations as bytes | | ||
| [@taquito/michelson-encoder](packages/taquito-michelson-encoder) | Creates JS abstractions of Smart Contracts | | ||
| [@taquito/michel-codec](packages/taquito-michel-codec) | Converts Michelson between forms, expands Macros, etc | | ||
| [@taquito/remote-signer](packages/taquito-remote-signer) | Provides the facility to use a remote signer, such as https://signatory.io | | ||
| [@taquito/rpc](packages/taquito-rpc) | RPC client library: every rpc endpoint has its own method | | ||
| [@taquito/signer](packages/taquito-signer) | Provides functionality to sign data using tezos keys | | ||
| [@taquito/utils](packages/taquito-utils) | Provides different encoding and decoding utilities | | ||
| [@taquito/tzip12](packages/taquito-tzip12) | TZIP-12 allows retrieving NFT/token metadata | | ||
| [@taquito/tzip16](packages/taquito-tzip16) | TZIP-16 allows retrieving contract metadata and executing off-chain views | | ||
| [@taquito/beacon-wallet](packages/taquito-beacon-wallet) | TZIP-10 implementation of a Wallet API | | ||
| [@taquito/http-utils](packages/taquito-http-utils) | Provides functionality configure http request options | | ||
| [@taquito/core](packages/taquito-core) | Defined core classes, types and interfaces | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would rephrase to: |
||
| [@taquito/sapling](packages/taquito-sapling) | Provides functionality to prepare and read sapling transaction | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. transactions* |
||
| [@taquito/contracts-library](packages/taquito-contracts-library) | Provides functionality to extend TezosToolkit with contract support | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would rephrase to: |
||
| [@taquito/ledger-signer](packages/taquito-ledger-signer) | Provides functionality to for ledger signer provider | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo /grammar mistake 'to' |
||
| [@taquito/timelock](packages/taquito-timelock) | Provides functionality to create and open timelock | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. timelocks* |
||
|
||
## API Documentation | ||
|
||
TypeDoc API documentation for Taquito [is available here](https://taquito.io/typedoc). | ||
|
||
|
||
## Versioning Strategy | ||
|
||
Supported versions of Taquito packages are maintained for the *current* and *next* (beta) protocol versions. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
*to configure and customize http requests