Skip to content

Commit

Permalink
docs: adding README.md file (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
kehiy authored Mar 31, 2024
1 parent 4b6fd1d commit 6581367
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 PAC Zone

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<p align="center">
<img alt="Teleport" src="./assets/teleport-transparent.png" width="150" height="150" />
</p>

<h3 align="center">
Teleport; Bridge your PAC coin to any other Chain
</h3>

<br/>

# What is Teleport?

The Teleport Protocol is a bridge from [Pactus](https://pactus.org) PAC coins to every other well-known blockchain out there using a wPAC Token.

## Reason that we made that

In [PAC Zone](https://github.com/PACZone) (powered by [Dezh](https://dezh.tech)), we decided to design and implement this protocol over Pactus to unleash the power of PAC on DeFi, etc.

## Future Vision

Currently Teleport it a semi-centralized protocol (half decentralized) since there is no contract support on Pactus. [More details about this are here](#how-it-works).

#### Our RoadMap

- [ ] We will add [wPAC](https://github.com/PACZone/TeleWrapped) to More blockchains such as Solana, TON, Aptos, etc.
- [ ] The main plan is to make this protocol 100% decentralized and trustless using multi-signature cryptography (Teleport Protocol V2).
- [ ] We have a plan to update the protocol and use Pactus contracts (still decentralized and trustless but using contracts) in 2025 Q1 once contracts are available on Pactus (Teleport Protocol V3).
- [ ] After contract support on the Pactus chain we will add wrapped of other coins on Pactus too(Teleport Protocol V3).

All V1(semi-centralized), V2(decentralizes using multi-signature), and V3(decentralizes smart-contract) [Wrapped Tokens](https://github.com/PACZone/TeleWrapped) minted on different networks, will be compatible with Teleport.

# How does it work?

## Teleport Protocol V1

This part is a description of how our V1 works (semi-centralized)

<!-- TODO -->

# Contribution

Contributions are welcome here, please make sure you make an issue before making a PR you are following linter and conventional commit rules and your tests are passing.

# License

The Teleport Protocol (THIS REPO IMPLEMENTATION) is published under [MIT License](./LICENSE).
Binary file added assets/teleport-transparent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/teleport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6581367

Please sign in to comment.