Skip to content

Commit

Permalink
Merge pull request #41 from jup-ag/0xYankee-Raccoons-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
benlvb authored May 8, 2024
2 parents 9de9667 + b564b08 commit 951e60e
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,42 @@
# Jupiter - Welcome to Solana
# Welcome to Solana by Jupiter

Welcome to Solana, is an initiatives to help gear curious cats coming out from the web2 world or from other chains to navigate Solana universe better.
Welcome to Solana is an initiative to onboard curious cats -- whether you're
crypto-native from other chains/ecosystems or completely new to crypto -- to
quick start your journey to begin exploring the Solana universe!

## How to add your project into the list of dApps to explore
## How to add your project into "Step 04 - Explore Dapps"

1. Add your logo into `/assets`.
- Logo image guideline - 200x200 (ideally with transparent background)
2. Link that image in `list.json` (or `wallets.json` if you're a wallet) following the rest of the examples in there.
3. Add these details for your protocol. (For `subname` or category, please pick the current category available and not some new category, we're looking to add more in the coming days)
1. Add your logo into [/assets](https://github.com/jup-ag/welcome-partners/tree/main/assets).
- Logo image guideline - 200x200
- Ideally with transparent background
- Ensure the logo is not too big, as it might be cropped when placed in a circle

2. Add your details into [/list.json](https://github.com/jup-ag/welcome-partners/blob/main/list.json).
- `name:` Name of your protocol
- `subname:` Category of your protocol
- `tag:` Tag for us to match to respective category
- `logo:` The filename of your logo
- `href:` URL that link to your protocol
4. For wallet protocol.

3. Or if you're a wallet protocol, add your details into [/wallets.json](https://github.com/jup-ag/welcome-partners/blob/main/wallets.json).
- `name:` Name of your wallet
- `logo:` The filename of your logo
- `href:` URL that link to your wallet

### Current list of tags
We aim to add more categories or classification in the future.
- DeFi
- Liquidity
- NFT
- Payments
- Games

Here's an example of PR to add a new protocol into the `Welcome to Solana` page: [Wormhole](https://github.com/jup-ag/welcome-partners/pull/3)
### Example PR
Here's an [example PR](https://github.com/jup-ag/welcome-partners/pull/3) to add a new protocol.

![example-PR](/assets/welcometosolana1.jpg)

## What we look at
We aim to safeguard our users and provide a more efficient method to add you to the list, please indicate by commenting any of the following in the PR.
- Traction (product or social/community traction)
- Security (OS codebase, audited, verifiable IDL)

0 comments on commit 951e60e

Please sign in to comment.