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

Update README.md #338

Merged
merged 1 commit into from
Feb 3, 2023
Merged

Update README.md #338

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
40 changes: 35 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# NEAR JavaScript SDK

<p>
<a href="https://www.npmjs.com/package/near-sdk-js" target="_blank">
<img alt="Version" src="https://img.shields.io/npm/v/near-sdk-js.svg">
</a>
<img src="https://img.shields.io/badge/node-%3E%3D14%20%3C16.6.0%20%7C%7C%20%3E16.6.0-blue.svg" />
<img src="https://img.shields.io/badge/pnpm-%3E%3D7-blue.svg" />
<a href="https://docs.near.org/sdk/js/introduction" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<a href="https://github.com/near/near-sdk-js/blob/develop/LICENSE" target="_blank">
<img alt="License: LICENSE" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
</a>
<a href="https://github.com/near/near-sdk-js/blob/develop/LICENSE-APACHE" target="_blank">
<img alt="License: LICENSE" src="https://img.shields.io/badge/License-Apache-yellow.svg" />
</a>
</p>

A JavaScript library for writing NEAR smart contracts.

> **Warning**
>
> This SDK is currently in **[`Alpha`](https://github.com/near/near-sdk-js/releases/)**.
Expand All @@ -10,9 +31,10 @@
> - [Provide suggestions or feedback](https://github.com/near/near-sdk-js/discussions) 💡
> - [Show us what you've built!](https://github.com/near/near-sdk-js/discussions/categories/show-and-tell) 💪

# NEAR JavaScript SDK
## Prerequisites

Set of libraries for writing smart contracts in JS/TS.
- node >=14 <16.6.0 || >16.6.0
- pnpm >=7

## Quick Start

Expand All @@ -24,12 +46,20 @@ This will scaffold a basic template for you 😎

## Documentation

- [Learn how to use](https://docs.near.org/tools/near-sdk-js) the library in your project
- [Learn how to use](https://docs.near.org/sdk/js/introduction) the library in your project
- Check our [detailed examples and tutorials](https://docs.near.org/tutorials/welcome)
- Find [source code examples](./examples) with common use cases
- 🏠 Learn more about NEAR on our [Documentation website](https://docs.near.org/)

## Contributing

- [Examples](./examples) with common use cases
If you are interested in contributing, please look at the [contributing guidelines](CONTRIBUTING.md).

- [Report issues you encounter](https://github.com/near/near-sdk-js/issues) 🐞
- [Provide suggestions or feedback](https://github.com/near/near-sdk-js/discussions) 💡
- [Show us what you've built!](https://github.com/near/near-sdk-js/discussions/categories/show-and-tell) 💪

## License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
This repository is distributed under the terms of both the [MIT license](https://github.com/near/near-sdk-js/blob/develop/LICENSE) and the [Apache License](https://github.com/near/near-sdk-js/blob/develop/LICENSE-APACHE) (Version 2.0).
See [LICENSE](LICENSE) and [LICENSE-APACHE](LICENSE-APACHE) for details.