Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanberckmans committed Jul 13, 2024
1 parent 932ed27 commit 40781d6
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
node_modules

Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 2 additions & 4 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

# Overview
# @3cities/core

TODO

# Usage
A package for dependencies shared across the 3cities monorepo.

0 comments on commit 40781d6

Please sign in to comment.