From df2a4881e02a8a8350b2ee64f90d6b4bef9d41e8 Mon Sep 17 00:00:00 2001 From: Ryan Berckmans Date: Sat, 13 Jul 2024 01:43:48 -0500 Subject: [PATCH] Update README --- .gitignore | 2 -- README.md | 13 +++++++++++++ packages/core/README.md | 6 ++---- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 1176f4d6..217c0f5a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,3 @@ -# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. - # dependencies node_modules diff --git a/README.md b/README.md index 2e7a8b65..657cb561 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,17 @@ +# [3cities](https://3cities.xyz/) [![dev branch](https://github.com/3cities/3cities/actions/workflows/0-build-dev.yml/badge.svg)](https://github.com/3cities/3cities/actions/workflows/0-build-dev.yml) [![staging release](https://github.com/3cities/3cities/actions/workflows/1-deploy-main-to-staging.yml/badge.svg)](https://github.com/3cities/3cities/actions/workflows/1-deploy-main-to-staging.yml) [![prod release](https://github.com/3cities/3cities/actions/workflows/2-deploy-staging-to-prod.yml/badge.svg)](https://github.com/3cities/3cities/actions/workflows/2-deploy-staging-to-prod.yml) + +Get multi-currency, multi-token, multi-L2, self-processing payments in one free, open, embedded widget, with no logins, signups, API keys, or tracking. + +3cities is a tool to pay and get paid on Ethereum. + +3cities is not a wallet, it's an app that lets you connect your wallet. + +3cities is not a token or a chain, it's an app that automatically searches the payment sender's wallet for the best payment method across ten popular tokens and a dozen L2s. + +Individuals can use 3cities for send or receive payments, donations, transfers, or deposits. + +Merchants can use 3cities to be accept transactional payments and self-process those payments offchain (be your own payment processor). Payments can be in USD or ETH, with EUR and other currencies soon to come. diff --git a/packages/core/README.md b/packages/core/README.md index 9389a594..cff390a9 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,6 +1,4 @@ -# Overview +# @3cities/core -TODO - -# Usage +A package for dependencies shared across the 3cities monorepo.