From a0e9f76ae832a2a2b7cb2e5b46e781d5a26ed282 Mon Sep 17 00:00:00 2001 From: Lulox Date: Mon, 7 Oct 2024 12:18:13 -0300 Subject: [PATCH] Updated README --- README.md | 45 +++++++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 39b4c8d..83d3fa8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ -๐Ÿฐ PunkSociety is an social dapp ๐Ÿซ‚ that allows users to monetize ๐Ÿ›’ their posts ๐Ÿ’ฌ. +Social dapp that allows users to monetize ๐Ÿ›’ their social activity ๐Ÿซ‚. +- ๐Ÿ’ฌ We don't show ads +- ๐Ÿ“Š We don't sell your data +- ๐Ÿ’ฐ You can earn from your social activity + +# ๐Ÿค˜ Features + +- ๐Ÿ’ฐ Liking, commenting, sharing and following send $ to the user on the other end - ๐Ÿคนโ€โ™‚๏ธ Posts can have text, image, audio, video and links. -- ๐Ÿ’ฌ Posting, liking, commenting, sharing and ๐Ÿซ‚ following are โ›ฝ gasless operations. -- ๐Ÿ€ Incentivized Minting: Users posts can be optionally minted as NFTs. Creators get income from mints of their posts. First minters of a post earn a share of future minting revenue. -- ๐Ÿ›’ Shopping cart: To streamline the user experience, collectors can mint multiple NFTs in a single transaction. +- ๐Ÿ›’ Shopping cart: To streamline the user experience, users can do multiple actions in a single transaction. - ๐Ÿ”” Receive notifications on activity. - ๐Ÿ’Œ Message other users. -- ๐ŸŽจ Customizable profile colors and layout. +- ๐ŸŽจ Customizable profile. - ๐Ÿ“š Built-in guides to help users understand Web3 and NFT minting. - ๐Ÿง‘โ€๐Ÿฆฝ Accessibility for visually impaired users. @@ -22,35 +27,35 @@ ## ๐Ÿ‘ฅ Phase 2 (Social Activity and Indexing) -- **Search**: By address, ENS or username - **Social features:** Following users, liking, commenting and sharing posts. -- **Integrate The Graph to index activity** and save RPC calls (Reference: [Bootstrap a Full Stack Modern dapp using the Scaffold-ETH CLI and Subgraph Extension](https://siddhantk08.hashnode.dev/bootstrap-a-full-stack-modern-dapp-using-the-scaffold-eth-cli-and-subgraph-extension) | [The Graph tool for creating a subgraph](https://thegraph.com/docs/en/developing/creating-a-subgraph/)) +- **Search**: By address, ENS or username - **Individual post pages** for displaying long texts and big images - **Notification system** +- **Integrate The Graph to index activity** and save RPC calls (Reference: [Bootstrap a Full Stack Modern dapp using the Scaffold-ETH CLI and Subgraph Extension](https://siddhantk08.hashnode.dev/bootstrap-a-full-stack-modern-dapp-using-the-scaffold-eth-cli-and-subgraph-extension) | [The Graph tool for creating a subgraph](https://thegraph.com/docs/en/developing/creating-a-subgraph/)) -## โœ๏ธ Phase 3 (Gasless activity) - -- **Signatures:** Allow users to interact with the platform without paying gas fees -- **Database:** To store and retrieve EIP 712 signatures (Reference: [SE-2 firebase-auth-extension](https://github.com/ByteAtATime/firebase-auth-extension)) -- **Whitelist:** Optional system to validate users to prevent spam - -## ๐Ÿ€ Phase 4 (Incentivized minting) +## ๐Ÿ€ Phase 3 (Incentivized socials) -- **Optional Tokenization with Incentivized Minting**: Users can post for free (gasless). The first user to mint a post as an NFT, if not the creator, is incentivized by receiving a share of the revenue from subsequent mints, creating an incentive for early minting. -- **Dashboard Insights**: Track and analyze minting revenue. -- **Revenue Model**: PunkSociety collects fees from mints. +- **Incentive model**: Likes, comments, shares and follows send $ to the user on the other end. +- **Dashboard Insights**: Track and analyze revenue. +- **Revenue Model**: PunkSociety collects fees. -## ๐ŸŽจ Phase 5 (Customization and ease of use) +## ๐ŸŽจ Phase 4 (Customization and ease of use) - **Post Collections**: Create and share collections on galleries visibles from user profiles. - **Profile Customization**: Users can customize colors and profile appearance. -- **Shopping cart**: To reduce gas fees and streamline the user experience, collectors can buy multiple NFTs in a single transaction. +- **Shopping cart**: To reduce gas fees and streamline the user experience, users can send multiple actions in a single transaction. - **Educational Content**: Include onboarding tutorials and step-by-step guides to help users and collectors understand NFTs and Web3 concepts. -## ๐Ÿ’Œ Phase 6 (Direct messages) +## ๐Ÿ’Œ Phase 5 (Direct messages) - **Direct messages:** Allow users to send private messages to each other +## โœ๏ธ Phase 6 (Gasless activity) + +- **Signatures:** Allow users to interact with the platform without paying gas fees +- **Database:** To store and retrieve EIP 712 signatures (Reference: [SE-2 firebase-auth-extension](https://github.com/ByteAtATime/firebase-auth-extension)) +- **Whitelist:** Optional system to validate users to prevent spam + ## ๐Ÿง‘โ€๐Ÿฆฝ Phase 7 (Accessibility) - **Accessibility support**: Website must be [ARIA compliant](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA)