From 631c1d28d8446be85dd259ce7d17c05facaf018e Mon Sep 17 00:00:00 2001 From: Nico Poggi <73345016+nicolaspoggi@users.noreply.github.com> Date: Thu, 29 Jun 2023 15:45:47 +0100 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index d7b5b272..5ef3dba7 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,22 @@ # Non-Fungible Apps - by Fleek -> 🚧 IMPORTANT 🚧 - This initiative is under development, so this repo should be treated as a WIP. Currently we are developing the NFA vision, outlined in [this article](https://blog.fleek.xyz/post/introducing-non-fungible-applications-update/ ) The goals and the roadmap might change as the project is shaped. +> 🚧 IMPORTANT 🚧 - This initiative is under development, so this repo should be treated as a WIP. The goals and the roadmap might change as the project is shaped. ## ⚡ Overview -This is the landing point for Fleek's initiative to decentralize web3 app frontend infrastructure, their distribution, and access, through Solidity smart contracts. +This is the landing point for our initiative to decentralize web3 app frontend infrastructure, their distribution, and access, through Non-fungible Applications, an NFT-based implementation. -**The goal of NFAs** is to put web3 application frontends on-chain to provide users with a verifiable and crypto-friendly way of accessing applications. NFAs bring a concept similar to the App Store experience of Web2, to Web3. Developers mint an web3 app's frontend as a NFA, putting the source on IPFS. Users can then mint a copy of said NFT, holding an immutable version of the app that they can load via their wallets, rendering it from IPFS directly (instead of a shared domain like app.uniswap.com). NFAs act as immutable, verified "app packages" put on-chain for decentralized distribution to users. +**The goal of NFAs** is to put web3 application frontends on-chain to provide users with a verifiable and crypto-friendly way of accessing applications. -**Resources:** -- [Read this article for an in-depth explanation of NFAs and the experience.](https://blog.fleek.xyz/post/introducing-non-fungible-applications-update/ ) -- [Visit the NFA website, reach out to us.](https://nfa.fleek.xyz) +1. Developers mint their app's frontend onto an NFT, where the frontend bundle is stored and referenced from IPFS. +2. Users mint prints of the NFA, which allows them to have a decentralized and permanently on-chain access point to any web3 app. +3. Users can load said apps without relying on DNS, for example, locally via the browser or through a potentially integrated wallet. -The vision is to have this on Ethereum Mainnet. We can create a network of smart contracts that represent the different parts of your stack, much like a Serverless.yaml or Cloudformation manifests that will enable us to develop use cases on top. +We want to have chain and wallet agnostic standard. While we use ERC-721 as a base reference, the base idea is to be kept simple, with extenesions/modules separate, so that NFAs can be easily replicable in any comparable chain, language, or NFT standard. -We had previously targeted Polygon but have changed it to Ethereum Mainnet for better interoperability and the security that mainnet provides. +We've developed a base set of contract code so now we want to harden it as well as add more metadata and features to support the additions of new modules - So be sure to open issues or PRs, as we welcome all contributions and collaborations! -We've developed a base set of contract code so now we want to harden it as well as add more metadata and features to support use cases with the first use case being community hosting. So be sure to check out the roadmap on the wiki. - -You can find the wiki [here](https://github.com/fleekxyz/non-fungible-apps/wiki) for more information about the project. ## ⌨️ Developing @@ -59,7 +56,7 @@ $ yarn format > ⚠️ Please make sure you are following the code styling guide before pushing the code -## 🛣️ Roadmap +## 🛣️ Development Roadmap Our goal is to reach a point where trustable Solidity contracts can be used for identifying properly the data about web3 applications. Within that goal, we want to also provide ways for users to organize and list information about their applications. To get at this we are currently starting with: @@ -69,10 +66,6 @@ Our goal is to reach a point where trustable Solidity contracts can be used for Later on, when the initiative proves its value, a service will be added to Fleek's platform in a friendly way for anyone to be able to get their applications onboard. -## 💡 Proof of concept - -The proof of concept was concluded last year and you can reach more information [here](https://github.com/fleekxyz/non-fungible-apps/wiki/%F0%9F%92%A1-Proof-of-Concept). - ## 📚 Dependency Highlights We use the following libraries to develop Fleek Non-Fungible Apps