From f1853c8a0d48a60f5f3f267d6675a3ffefe58290 Mon Sep 17 00:00:00 2001 From: David Garcia Date: Mon, 24 Feb 2020 14:33:10 +0000 Subject: [PATCH] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 89af4a3918..0b09b2a4f4 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ -# Symbol-sdk for TypeScript and JavaScript +# Symbol SDK for TypeScript and JavaScript [![npm version](https://badge.fury.io/js/symbol-sdk.svg)](https://badge.fury.io/js/symbol-sdk) [![Build Status](https://api.travis-ci.org/nemtech/symbol-sdk-typescript-javascript.svg?branch=master)](https://travis-ci.org/nemtech/symbol-sdk-typescript-javascript) [![Coverage Status](https://coveralls.io/repos/github/nemtech/symbol-sdk-typescript-javascript/badge.svg?branch=travis-ci)](https://coveralls.io/github/nemtech/symbol-sdk-typescript-javascript?branch=travis-ci) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -The official symbol-sdk for TypeScript and JavaScript, available for browsers, mobile applications, and NodeJS, to work -with the Symbol (a.k.a Catapult) +The Symbol SDK for TypeScript / JavaScript allows you to develop web, mobile, and Node.js applications. ## Important Notes ### _Fushicho_ Network Compatibility (catapult-server@0.9.3.1) -**!!! Please be noted that the NEM2-SDK is rebranded to SYMBOL-SDK now.**. +**!!! Please be noted that the NEM2-SDK is rebranded to SYMBOL-SDK now**. Due to a network upgrade with [catapult-server@Fushicho](https://github.com/nemtech/catapult-server/releases/tag/v0.9.3.1) version, **it is recommended to use this package's 0.17.1 version and upwards to use this package with Fushicho versioned networks**. @@ -44,7 +43,7 @@ To get the full description of the available classes and their functions, check Use the following available resources to get help: -- [symbol-sdk-typescript-javascript documentation][docs] +- [Symbol SDK Typescript/Javascript Reference][docs] - If you found a bug, [open a new issue][issues] ## Contributing