From 422b34bf329b85de5146416b4e5f7461af8081f3 Mon Sep 17 00:00:00 2001 From: Max Harpunsky Date: Sat, 27 Aug 2022 03:10:50 +0300 Subject: [PATCH] fix: README add reference to create-near-app (#197) * fix: README add reference to create-near-app --- .gitignore | 3 ++- README.md | 17 +++++++---------- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index 2d96c055f..971b987d5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ node_modules yarn-error.log -vendor \ No newline at end of file +vendor +.idea diff --git a/README.md b/README.md index 693c294d3..54cecd0eb 100644 --- a/README.md +++ b/README.md @@ -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 `.wasm` will be generate at `/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: