Skip to content

Commit 548ad5d

Browse files
committed
improve the readme
1 parent d2d7727 commit 548ad5d

File tree

2 files changed

+70
-6
lines changed

2 files changed

+70
-6
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Julian Ćwirko
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,52 @@
1-
### Intro to MultiversX blockchain interactions with JavaScript SDK
1+
# MultiversX JavaScript SDK Examples
22

3-
The repository for the article: [Intro to MultiversX blockchain interactions with JavaScript SDK](https://www.julian.io/articles/multiversx-js-sdk-intro.html)
3+
Welcome to the repository containing code examples for the JavaScript SDK of the MultiversX blockchain. This collection of examples demonstrates various features and capabilities of the SDK to help developers effectively integrate and utilize MultiversX in their projects.
44

5-
Run:
6-
- `npm install`
7-
- `node transaction.js`
5+
## Overview
86

9-
Video: https://youtu.be/Fxxdly9QYHw
7+
This repository is structured to gradually include multiple demonstrations. Each example is organized into its own section and will be tagged accordingly to facilitate easy navigation and version control.
8+
9+
## Getting Started
10+
11+
To begin exploring the available examples, clone this repository and navigate to the specific section you are interested in:
12+
13+
```bash
14+
git clone https://github.com/xdevguild/multiversx-js-sdk-examples.git
15+
cd multiversx-js-sdk-examples
16+
```
17+
18+
### Prerequisites
19+
20+
Ensure you have Node.js installed on your system to run the examples. You can download Node.js from [nodejs.org](https://nodejs.org/).
21+
22+
## Current Examples
23+
24+
Currently, the repository hosts a single example. More examples will be added progressively. Each part/example is associated with a separate git tag. As new examples are added, each tag will not only include the new work but will also retain earlier examples, which are organized into separate files with descriptive names. This structure allows users to easily understand and trace the development of each example, as well as access previous versions cleanly and efficiently.
25+
To check out a specific tag, use:
26+
27+
```bash
28+
git checkout <tag_name>
29+
```
30+
31+
### Example 1: Setup and basic transaction
32+
33+
- **Tag**: `setup-and-transaction`
34+
- **Description**: This example demonstrates how to setup required tools and helpers and perform basic transaction using the MultiversX JavaScript SDK on the devnet.
35+
- **Article**: [Intro to MultiversX blockchain interactions with JavaScript SDK](https://www.julian.io/articles/multiversx-js-sdk-intro.html)
36+
- **Video**: [Intro to MultiversX blockchain interactions with JavaScript SDK](https://www.youtube.com/watch?v=Fxxdly9QYHw)
37+
38+
## Security and Wallet Information
39+
40+
The examples use a demo wallet with a hardcoded password. All interactions occur on the **devnet** (development network of MultiversX), ensuring that it is safe to expose the wallet credentials. The devnet is designed for testing and development, involving no real assets. Don't do this on the mainnet.
41+
42+
## Disclaimer
43+
44+
These examples are provided "as is" without any warranty. They are intended for educational and development purposes only. By using these examples on the mainnet, you acknowledge that you do so at your own risk.
45+
46+
## Contributing
47+
48+
Contributions are welcome! If you have suggestions, improvements, or additional examples, feel free to open an issue or submit a pull request.
49+
50+
## Contact
51+
52+
For further assistance or inquiries, feel free to reach out through X ([@theJulianIo](http://x.com/theJulianIo)) or by submitting an issue in this repository.

0 commit comments

Comments
 (0)