Skip to content

Commit

Permalink
Update README.md (#170)
Browse files Browse the repository at this point in the history
  • Loading branch information
PrasanthYT authored Feb 27, 2024
1 parent 2b2dda3 commit 43b9462
Showing 1 changed file with 57 additions and 28 deletions.
85 changes: 57 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,90 @@
# CORD.js <!-- omit in toc -->
# CORD.js

Provides a collection of classes and methods to interact with the Cord network.
CORD.js is a JavaScript library that provides a collection of classes and methods to interact with the Cord network.

- [Build to see changes](#build-to-see-changes)
- [To consume SDK in your project](#to-consume-sdk-in-your-project)
## Table of Contents
- [Building the SDK](#building-the-sdk)
- [Experimenting with SDK Methods](#experimenting-with-sdk-methods)
- [Demo Methods](#demo-methods)
- [Statement Method](#statement-method)
- [Network Score Method](#network-score-method)
- [Asset Method](#asset-method)
- [Consuming the SDK in Your Project](#consuming-the-sdk-in-your-project)

---

## Build to see changes
## Building the SDK

Clone this repo and navigate into it.
To build the SDK and see changes, follow these steps:

```
yarn
```
1. Clone this repository to your local machine:

Note that **before you see your changes from the SDK, you have to build it** by executing a `build`:
```bash
git clone <repository_url>
cd <repository_directory>

```
yarn build
```
2. Install dependencies using yarn:

```bash
yarn
## Experiment the SDK methods
2. Build the SDK:
```bash
yarn build

Once the build of the package is complete (with `yarn build`), one can try the below methods to check
if methods are working.
## Experimenting with SDK Methods
## Demo Methods
Once the SDK is built, you can experiment with the provided methods.

Note:
Ensure the cord instance is running locally by following the README.md under the CORD repo.
Follow the instructions under the topic - "Run the node."
## Statement Method:

The `demo-statement` method allows you to interact with statement-related functionalities.

To run the statement demo, execute the following command:

```bash
yarn demo-statement
```

$ yarn demo-statement
## Network Score Method:

$ yarn demo-network-score
The `demo-network-score` method demonstrates methods related to network scores.

$ yarn demo-asset
To run the network score demo, execute the following command:

```bash
yarn demo-network-score
```
The output of these runs are self-explanatory. For reference of how this is structured,
you can refer to the source of the demo scripts.

## Asset Method:

## To consume SDK in your project
The `demo-asset` method showcases methods related to assets.

Install the SDK by running the following commands in your project directory
To run the asset demo, execute the following command:

```bash
yarn demo-asset
```

The output of each demo script will demonstrate the functionality of the corresponding method. For a detailed structure of the demo scripts, refer to the source code.

## Consuming the SDK in Your Project

To use the SDK in your project, follow these steps:

1. Navigate to your project directory.

2. Install the SDK using npm or yarn:

```bash
npm install @cord.network/sdk
```

Or with `yarn`:
Or with yarn:

```bash
yarn add @cord.network/sdk
```


Once installed, you can import and utilize the SDK in your project as needed.

0 comments on commit 43b9462

Please sign in to comment.