Adding License and readme

harmony-one · Mar 10, 2023 · b2cdd30 · b2cdd30
1 parent cf1b251
commit b2cdd30
Show file tree

Hide file tree

Showing 2 changed files with 293 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,59 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
+
+0. Additional Definitions.
+As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.
+
+“The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
+
+a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
+b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
+3. Object Code Incorporating Material from Library Header Files.
+The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
+
+a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
+b) Accompany the object code with a copy of the GNU GPL and this license document.
+
+4. Combined Works.
+You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
+
+a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
+b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
+c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
+d) Do one of the following:
+0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
+e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
+
+5. Combined Libraries.
+You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
+
+a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
+b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
+
+6. Revised Versions of the GNU Lesser General Public License.
+The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
diff --git a/README.md b/README.md
@@ -0,0 +1,234 @@
+<a name="readme-top"></a>
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![LGPL-3.0-License][license-shield]][license-url]
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="http://1.country">
+    <img src="https://i.imgur.com/R75Arym.png" alt="Logo" width="80" height="80">
+  </a>
+
+  <h3 align="center">1.country</h3>
+
+  <p align="center">
+    Connecting Web2 domains and Web3 profiles
+    <br />
+    <a href="https://harmony.one/1country"><strong>Explore our vision »</strong></a>
+    <br />
+    <br />
+    <a href="https://1.country">Try it</a>
+    ·
+    <a href="https://github.com/harmony-one/1-country.frontend/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/harmony-one/1-country.frontend/issues">Request Feature</a>
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+Hidden State, a Harmony ecosystem partner, is launching the world’s first integrated platform 1.country for Web2 domain names and Web3 profiles, giving users a unified digital identity & brand solution.
+
+1.country allows users to claim a Web3 name .1 that also directs to a browsable Web2 domain .country. Users can now simultaneously own their Web3 identity and a browsable website in one transaction. 1.country offers 1-3 character premium Web3 names on Harmony’s 2-second finality blockchain that also resolves to proper Web2 domains within 5 minutes.
+
+1.country delivers an ICANN approved top-level domain with the superpowers of smart contracts. While the first use case is creating a profile page, 1.country is an open platform for builders to develop the infrastructure and tools for a more fair digital economy. To create your unique digital identity, register a 1.country domain today.
+[![Product Name Screen Shot][product-screenshot]](https://1.country)
+
+You can buy a Web2 and Web3 domain today in one simple transaction at [1.country](1.country). 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+### Built With
+[![React][React.js]][React-url]
+[![mobx][mobx]][mobx-url]
+[![Web3][Web3]][Web3-url]
+[![wagmi][wagmi]][wagmi-url]
+<!-- [![styled-components][styled-components]][styled-components-url] -->
+<!-- [![react-router][react-router]][react-router-url] -->
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- GETTING STARTED -->
+<!-- ## Getting Started
+
+This is an example of how you may give instructions on setting up your project locally.
+To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+This is an example of how to list things you need to use the software and how to install them.
+* npm
+  ```sh
+  npm install npm@latest -g
+  ```
+
+### Installation
+
+_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
+
+1. Get a free API Key at [https://example.com](https://example.com)
+2. Clone the repo
+   ```sh
+   git clone https://github.com/your_username_/Project-Name.git
+   ```
+3. Install NPM packages
+   ```sh
+   npm install
+   ```
+4. Enter your API in `config.js`
+   ```js
+   const API_KEY = 'ENTER YOUR API';
+   ```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
+
+
+
+<!-- USAGE EXAMPLES
+## Usage
+
+Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+
+_For more examples, please refer to the [Documentation](https://example.com)_
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
+
+
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [x] Phase 1: Launch with Web2 and Web3 Integrations
+    - [x] Web2 Top Level Domains with on-chain Web3 names
+    - [x] Identify profiles for creators
+    - [x] 1-3 character premium domains
+- [ ] Phase 2: Build with Radical Markets and Open Development
+    - [x] NFT metadata with visuals and identity
+    - [ ] Wallet-to-wallet payment and domain transfers
+    - [ ] Subdomains and domain renewal [radical markets](https://vitalik.ca/general/2018/04/20/radical_markets.html) pricing
+    - [ ] Software Development Kit (SDK)
+- [ ] Phase 3: Expand with New Creator Tools and Products
+    - [ ] SMS wallet and multi-chain integration
+    - [ ] Email services and Customer Relations Management (CRM)
+    - [ ] Video and live streaming content
+
+<!-- See the [open issues](https://github.com/harmony-one/1-country.frontend/issues) for a full list of proposed features (and known issues). -->
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/<feature>`)
+3. Commit your Changes (`git commit -m 'Add <feature>'`)
+4. Push to the Branch (`git push origin feature/<feature>`)
+5. Open a Pull Request
+
+To check out more of the backend and smart contract features related to this project, check out [dot-country](https://github.com/harmony-one/dot-country) and [ens-deployer](https://github.com/harmony-one/ens-deployer).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the LGPL-3.0 license.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## Contact
+
+[![twitter][twitter]][twitter-url]
+[![email][email]][email-url]
+[![telegram][telegram]][telegram-url]
+[![discord][discord]][discord-url]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+
+Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
+* [LGPL-3.0 license](https://github.com/harmony-one/1-country.frontend/main/LICENSE)
+* [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[twitter]: https://img.shields.io/badge/[email protected]?style=for-the-badge&logo=twitter&color=1c1d1f
+[twitter-url]: https://twitter.com/harmonyprotocol
+[email]: https://img.shields.io/badge/[email protected]?style=for-the-badge&logo=gmail&color=1c1d1f
+[email-url]: mailto:[email protected]
+[telegram]: https://img.shields.io/badge/-harmony__one-black.svg?style=for-the-badge&logo=telegram&color=1c1d1f
+[telegram-url]: https://t.me/harmony_one
+[discord]: https://img.shields.io/badge/-harmony_one-black.svg?style=for-the-badge&logo=discord&color=1c1d1f
+[discord-url]: https://discord.com/invite/rdCmBpe
+
+
+[contributors-shield]: https://img.shields.io/github/contributors/harmony-one/1-country.frontend.svg?style=flat-square
+[contributors-url]: https://github.com/harmony-one/1-country.frontend/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/harmony-one/1-country.frontend.svg?style=flat-square
+[forks-url]: https://github.com/harmony-one/1-country.frontend/network/members
+[stars-shield]: https://img.shields.io/github/stars/harmony-one/1-country.frontend.svg?style=flat-square
+[stars-url]: https://github.com/harmony-one/1-country.frontend/stargazers
+[issues-shield]: https://img.shields.io/github/issues/harmony-one/1-country.frontend.svg?style=flat-square
+[issues-url]: https://github.com/harmony-one/1-country.frontend/issues
+[license-shield]: https://img.shields.io/github/license/harmony-one/1-country.frontend?style=flat-square
+[license-url]: https://github.com/harmony-one/1-country.frontend/main/LICENSE
+
+[product-screenshot]: https://i.imgur.com/njNlM9X.png
+
+[React.js]: https://img.shields.io/badge/[email protected]?style=for-the-badge&logo=react&logoColor=61DAFB
+[React-url]: https://reactjs.org/
+[styled-components]: https://img.shields.io/badge/styledcomponents-20232A?style=for-the-badge&logo=styled-components&logoColor=DB7093
+[styled-components-url]:https://styled-components.com/
+[mobx]: https://img.shields.io/badge/mobx-20232A?style=for-the-badge&logo=mobx&logoColor=FF9955
+[mobx-url]: https://mobx.js.org/README.html
+[react-router]: https://img.shields.io/badge/reactrouter-20232A?style=for-the-badge&logo=react-router&logoColor=CA4245
+[react-router-url]: https://reactrouter.com/en/main
+[web3]: https://img.shields.io/badge/[email protected]?style=for-the-badge&logo=web3.js&logoColor=F16822
+[web3-url]: https://web3js.readthedocs.io/en/v1.8.2/
+[wagmi]: https://img.shields.io/badge/[email protected]?style=for-the-badge&logoColor=F16822
+[wagmi-url]: https://wagmi.sh/