Skip to content

Commit 422b34b

Browse files
authored
fix: README add reference to create-near-app (#197)
* fix: README add reference to create-near-app
1 parent 2fb1555 commit 422b34b

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules
22
yarn-error.log
3-
vendor
3+
vendor
4+
.idea

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
1-
# NEAR-SDK-JS
1+
# NEAR JavaScript SDK
22

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

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

9-
## Usage
7+
npx create-near-app
108

11-
1. Copy project layout including configurations from `examples/` as a starting point
12-
2. Write smart contracts with JavaScript. You can use most npm packages that uses portable ES2020 features.
13-
3. Build the contract with `yarn build`.
14-
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.
9+
This will scaffold a basic template for you 😎
10+
11+
Learn more in our [Quick Start guide](https://docs.near.org/develop/quickstart-guide).
1512

1613
## Running Examples
1714
There are a couple of contract examples in the project:

0 commit comments

Comments
 (0)