Skip to content

Commit

Permalink
fix: README add reference to create-near-app (#197)
Browse files Browse the repository at this point in the history
* fix: README add reference to create-near-app
  • Loading branch information
maxhr authored Aug 27, 2022
1 parent 2fb1555 commit 422b34b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
yarn-error.log
vendor
vendor
.idea
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
# NEAR-SDK-JS
# NEAR JavaScript SDK

## Installation
It is tested on Ubuntu 20.04, M1 Mac and Intel Mac. Other linux should also work but they're not tested.
## Quick Start

1. Make sure you have make, cmake and nodejs. On Linux, also make sure you have gcc.
2. `make setup`
Use [`create-near-app`](https://github.com/near/create-near-app) to quickly get started writing smart contracts in JavaScript on NEAR.

## Usage
npx create-near-app

1. Copy project layout including configurations from `examples/` as a starting point
2. Write smart contracts with JavaScript. You can use most npm packages that uses portable ES2020 features.
3. Build the contract with `yarn build`.
4. If no errors happens, a `<contract-name>.wasm` will be generate at `<project-dir>/build/`. It can be tested with workspaces-js and deployed to a NEAR node.
This will scaffold a basic template for you 😎

Learn more in our [Quick Start guide](https://docs.near.org/develop/quickstart-guide).

## Running Examples
There are a couple of contract examples in the project:
Expand Down

0 comments on commit 422b34b

Please sign in to comment.