XChainJS Typedoc Documentation Repository

Welcome to the XChainJS Typedoc Documentation Repository!

This repository hosts documentation for XChainJS, a library offering a unified interface across multiple blockchains. It's designed for seamless integration into wallets and other applications, providing simplicity and speed.

Setup

To access the documentation locally, follow these steps:

Clone the repository to your machine:

git clone https://github.com/kairosweb3/xchain-docs

Navigate to the cloned directory:
```
cd xchain-docs
                
```
Install dependencies:
```
npm install
                
```
Install Nodejs dependecies to setup http-server in this repository.
```
   npm i http-server
                
```

Running the Documentation Server

To start a local server serving the documentation:

Navigate to the repository's root directory.
Launch the Node.js server:
```
http-server
                
```
This will initiate a server at http://localhost:3000.

Accessing Documentation

Once the server is up, access the documentation by opening http://localhost:3000 in your web browser. There, you'll find detailed documentation for various packages.
To access the documentation file for each particular package, navigate to the docs folder on the localhost URL.
Each package is represented by HTML files generated by Typedoc.

How this Repository Benefits Developers

XChainJS documentation plays a crucial role for developers in several ways:

Clarity and Guidance: It offers clear, well-structured documentation on utilizing XChainJS for blockchain integration, facilitating easier development and integration processes.
Reference Material: Developers can refer to this repository to understand the functionalities and APIs provided by XChainJS, aiding in the development of wallets and other blockchain-related applications.
Troubleshooting and Support: Detailed documentation assists developers in troubleshooting issues and seeking support, thereby expediting the development lifecycle and improving overall user experience.

Contribution

We welcome contributions to enhance the documentation. If you spot errors or have suggestions for improvement, please don't hesitate to open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.