Skip to content

Latest commit

 

History

History

documentation

README.md

Alice's Ring Documentation

Welcome to the Alice's Ring Documentation site. This site provides comprehensive documentation for the Metamask Snap for SAG and LSAG signatures.

Overview

This documentation site covers the following topics:

  • Overview of the Alice's Ring
  • Detailed explanations of ring signatures (SAG and LSAG)
  • Installation and usage instructions for all the libraries
  • Frequently Asked Questions (FAQ)
  • Information about Cypher Lab

Getting Started

Prerequisites

Before you begin, ensure you have the following installed on your local machine:

  • Node.js (>= 18.x)
  • npm or yarn

Installation

  1. Install the dependencies: 
    yarn install

Running the Documentation Site

To start the local development server, run:

yarn start

This command starts the development server and opens a browser window. Most changes are reflected live without having to restart the server.

Building the Documentation Site

To build the documentation site for production, run:

yarn build

This command generates static content into the build directory and can be served using any static file hosting service.

Contributing

We welcome contributions from the community. To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes.
  4. Commit your changes with a descriptive commit message.
  5. Push your changes to your forked repository.
  6. Create a pull request to the main repository.

License

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

Contact

For any questions or feedback, please contact us at [email protected].

Acknowledgements

We would like to thank all contributors and the community for their support and feedback.

This documentation site is built with Docusaurus.