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.

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

Merged
merged 36 commits into from
May 10, 2024
Merged
Changes from 34 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
81f82f7
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Nov 7, 2023
eab82bb
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Nov 10, 2023
0259cdd
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Nov 21, 2023
b1a2679
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Nov 27, 2023
45223bd
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Nov 28, 2023
a82b5cd
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Dec 1, 2023
3b08821
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Dec 5, 2023
bfd1f49
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Dec 5, 2023
5d0a7cc
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Dec 13, 2023
7b9d4c1
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Dec 14, 2023
37e14e4
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Dec 28, 2023
dc68be9
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Jan 9, 2024
f259810
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Jan 16, 2024
6fdda51
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 6, 2024
298b413
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 12, 2024
06af53b
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 14, 2024
e4853cf
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 16, 2024
fc2e2b0
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 20, 2024
a64564e
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 21, 2024
ae561ab
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 22, 2024
0a2974b
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Feb 29, 2024
708d150
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Mar 1, 2024
e018e9e
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Mar 8, 2024
4523ffb
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Mar 19, 2024
3c386ad
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Mar 26, 2024
dffb59c
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Apr 5, 2024
b58a460
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Apr 5, 2024
8fa69af
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Apr 8, 2024
a896a23
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Apr 9, 2024
fd47258
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Apr 11, 2024
00892e8
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Apr 11, 2024
a39aaa5
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang Apr 17, 2024
82f5a89
Merge branch 'master' of https://github.com/ecadlabs/taquito
hui-an-yang May 9, 2024
0f41235
docs: updated readme
hui-an-yang May 9, 2024
1f7a1a6
docs: addressed review comments
hui-an-yang May 10, 2024
fe3398d
docs: addressed review comments
hui-an-yang May 10, 2024
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
43 changes: 22 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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!

Expand All @@ -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 |
Copy link
Collaborator

@dsawali dsawali May 10, 2024

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

| [@taquito/core](packages/taquito-core) | Defined core classes, types and interfaces |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rephrase to:
'Provides parent and core types, classes, and interfaces for other Taquito packages or external uses'

| [@taquito/sapling](packages/taquito-sapling) | Provides functionality to prepare and read sapling transaction |
Copy link
Collaborator

Choose a reason for hiding this comment

The 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 |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rephrase to:
'Provides functionality specify static data related to contracts'

| [@taquito/ledger-signer](packages/taquito-ledger-signer) | Provides functionality to for ledger signer provider |
Copy link
Collaborator

Choose a reason for hiding this comment

The 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 |
Copy link
Collaborator

Choose a reason for hiding this comment

The 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.
Expand Down
Loading