Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 2.46 KB

README.md

File metadata and controls

87 lines (52 loc) · 2.46 KB
Raw

Published Branch

The current branch live at https://arweave-tools.irys.xyz is feat/slimdocs. This is the only branch currently being maintained. PRs should be submitted to that branch only.

Irys Developer Tools For Arweave

This is the docs repository for Irys's Developer Tools for Arweave. A set of high-performance tools for building on Arweave. This includes the:

  • Irys SDK
  • Irys CLI
  • Irys Query package
  • Guides and Tutorials

What is Irys?

Irys is the first L1 programmable datachain, designed to optimize data storage and execution. By combining storage and execution, it significantly increases the usefulness of blockspace, enabling a wider range of web services to come onchain that aren’t possible right now.

Irys empowers developers to create and innovate like never before. With Irys, builders can eliminate dependencies, integrate efficient onchain data, and unlock new possibilities for dynamic, real-time applications—all within a unified platform.

In addition to the L1, Irys also maintains this set of developer tools for building on Arweave.

Installation

  1. Clone the repository:

  2. Install dependencies:

    Make sure you have Node.js and npm installed. Then, run:

    npm install

  3. Run the development server:

    Start the local development server with:

    npm run dev

    Open http://localhost:3000 with your browser to see the result.

Submitting a Pull Request (PR)

We welcome contributions from the community! To submit a PR, follow these steps:

  1. Fork the repository:

    Click the "Fork" button on the top right of the repository page.

  2. Clone your fork:

    git clone https://github.com/your-username/irys-docs-v2.git
cd irys-docs

  3. Create a new branch:

    git checkout -b feature/your-feature-name

  4. Make your changes:

    Implement your changes and commit them with a clear and concise message:

    git add .
git commit -m "Add feature: your-feature-name"

  5. Push to your fork:

    git push origin feature/your-feature-name

  6. Create a Pull Request:

    Go to the original repository and click on the "New Pull Request" button. Select your fork and branch as the source, and the main branch of the original repository as the target. Provide a clear description of your changes and submit the PR.

License

This project is licensed under the MIT License.