Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 4.49 KB

README.md

File metadata and controls

115 lines (81 loc) · 4.49 KB
Raw

⚠️ NOTICE: This repository has been moved to UnstoppableSwap/core. Please refer to the new repository for the latest updates. ⚠️

Graphical User Interface (GUI) For Trustless Cross-Chain XMR<>BTC Atomic Swaps

Download . Report Bug . Request Feature

Downloads Contributors Issues License

Table Of Contents

main screen

Documentation

Please note that the documentation is still a work in progress.

Getting Started

Please download the GUI from the release page. Choose your respective version (.dmg for Mac, .AppImage for Linux and .exe for Windows).

Donate

We rely on generous donors like you to keep development moving forward. To bring Atomic Swaps to life, we need resources. If you have the possibility, please consider making a donation to the project. All funds will be used to support contributors and critical infrastructure.

If you interested in a partnership or want to support the project in a way that requires coordination with the contributors, contact @binarybaron:matrix.org on Matrix.

49LEH26DJGuCyr8xzRAzWPUryzp7bpccC7Hie1DiwyfJEyUKvMFAethRLybDYrFdU1eHaMkKQpUPebY4WT3cSjEvThmpjPa

bc1qz6lfs0r206396a9psunmkfpqh7sdf2zh3e7tnf

Development

To get a local copy up and running follow these steps.

Prerequisites

Before proceeding you should install the following:

Installation

Clone the repository, install all dependencies using npm and start the GUI on testnet.

git clone --branch main https://github.com/binarybaron/unstoppableswap-gui
cd unstoppableswap-gui
npm install
TESTNET=true npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements