Merge pull request #2 from symbol-blockchain-community/update-documents

update documents

Author: ymuichiro

.github/workflows/npm-publish.yml

@@ -16,7 +16,6 @@ jobs:
         with:
           node-version: 20
       - run: npm ci
-      - run: npm lint
       - run: npm build
 
   publish-npm:

README.md

@@ -1,6 +1,8 @@
-# Symbol SDK Crypto
+# expo-symbol-sdk
 
-This library is a lightweight SDK extracted from the Symbol SDK’s use of Node.js’s crypto module. To avoid complex dependency resolutions on platforms like Web, Node.js, and React Native, this library serves as the base for SDKs tailored to each platform. This light version of the SDK offers the following features:
+expo-symbol-sdk is a symbol-sdk optimized for use on expo managed react native. This sdk can be used by application developers simply by installing it, without the need for complex environment setup.
+
+However, this sdk is a lightweight package that extracts only the functions of symbol-sdk that depend on the node.js core module. Only the following features are provided compared to the original symbol-sdk:
 
 - Creation and loading of private keys
 - Encryption and decryption of messages
@@ -32,7 +34,7 @@ console.log(account);
 Signing a transaction created with symbol-sdk.
 
 ```ts
-const account = Account.generateNewAccount(NetworkType.TEST_NET);
+import { Account, NetworkType } from '@symbol-blockchain-community/expo-symbol-sdk';
 
 const generationHash = '49D6E1CE276A85B70EAFE52349AACCA389302E7A9754BCF1221E79494FC665A4';
 const serializedTransactionPayload =
@@ -43,15 +45,15 @@ const serializedTransactionPayload =
   '985441F84300000000000003983E640900000098EC10797B167D59E419781125' +
   'EE36676AA61D9E4F90CDAF0E000000000000000048656C6C6F2053796D626F6C21';
 
+const account = Account.generateNewAccount(NetworkType.TEST_NET);
 const signedPayload = account.sign(serializedTransactionPayload, generationHash);
 console.log(signedPayload);
 ```
 
 Encryption and decryption of messages.
 
 ```ts
-import { MessageEncoder, Account } from '@symbol-blockchain-community/expo-symbol-sdk';
-import { Account, NetworkType } from 'symbol-sdk';
+import { MessageEncoder, Account, NetworkType } from '@symbol-blockchain-community/expo-symbol-sdk';
 
 const alice = Account.generateNewAccount(NetworkType.TEST_NET);
 const bob = Account.generateNewAccount(NetworkType.TEST_NET);
@@ -60,14 +62,23 @@ const messageEncoder = new MessageEncoder(alice.privateKey);
 const messageDecoder = new MessageEncoder(bob.privateKey);
 
 const encoded = messageEncoder.encode(bob.publicKey, 'Hello, symbol!');
-console.log('encoded: ', encoded);
 const decoded = messageDecoder.tryDecode(alice.publicKey, encoded);
+console.log('encoded: ', encoded);
 console.log('decoded: ', decoded);
 ```
 
+`MessageEncoder.encode` returns a `Uint8Array`. It can be used directly with symbol-sdk@3. However, if you need to handle it as a string, you can convert it to hex with the following implementation.
+
+```javascript
+const hex = Array.from(encoded).map(b => b.toString(16).padStart(2, '0')).join('');
+```
+
+Application developers do not need to be aware of this, but when an encrypted message is sent to a node and retrieved from the node again, the "01" will be added to the beginning of the hex string. This is a flag to indicate that the message is encrypted.
+If you want to send an encrypted message to another application without going through a node and decrypt it using the SDK, you need to add "01" to the beginning of the hex yourself.
+
 ## Contributing
 
-expo-symbol-crypto is an open-source project. Contributions are welcome. Please refer to the GitHub repository for details.
+`expo-symbol-crypto` is an open-source project. Contributions are welcome. Please refer to the GitHub repository for details.
 
 ## License
 
@@ -76,3 +87,9 @@ This software is provided under the [MIT License](./LICENSE).
 ## Contact
 
 For questions or feedback, please contact us through the GitHub repository.
+
+## External sites
+
+* [Symbol Community Web](https://symbol-community.com)
+* [Symbol Document](https://docs.symbol.dev/ja/index.html)
+* [Symbol/NEM Discord](https://discord.gg/xymcity)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@symbol-blockchain-community/expo-symbol-sdk",
-  "version": "0.0.1-6",
+  "version": "1.0.0",
   "description": "This package is a standalone alternative to symbol-sdk for managed React Native environments with Expo.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -9,7 +9,7 @@
   "author": "ym.u.ichiro@gmail.com",
   "homepage": "https://symbol-community.com",
   "repository": {
-    "url": "https://github.com/Symbol-Blockchain-Community/expo-symbol-sdk"
+    "url": "https://github.com/symbol-blockchain-community/expo-symbol-sdk"
   },
   "publishConfig": {
     "access": "public"
@@ -58,4 +58,4 @@
     "README.md",
     "LICENSE"
   ]
-}
+}