Skip to content

Commit

Permalink
Remove all documentation here in favor of docs site (#222)
Browse files Browse the repository at this point in the history
* Update with relevant details

* Greatly simplify landing page

* Delete PDFs

* More doc cleanup

* Finish deleting all docs. We don't need them

---------

Co-authored-by: creativedrewy <Andrew Watson [email protected]>
  • Loading branch information
creativedrewy and creativedrewy authored Jul 10, 2023
1 parent 23558dd commit 04df00c
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 456 deletions.
64 changes: 23 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,35 @@
# Welcome publishers!

We’re glad you’re ready to learn about publishing your Web3 apps on the Solana dApp Store, the fee-free app store for the [Saga](https://solanamobile.com/saga) device.
# dApp Publishing CLI

What do we mean by fee-free? We mean that no fees are collected by Solana Mobile Inc. from users of the dApp Store. There may still be network transaction fees or app-specific fees associated with usage of the Solana dApp Store, or of apps installed by it. None of these fees are collected by, or on behalf of, Solana Mobile Inc.
Tooling for publishing to the Solana Mobile dApp Store.

Want to know more? Read more [about the Solana dApp Store](docs/ABOUT.md).
For all documentation regarding usage of the tooling, including a thorough walkthrough of the dApp publishing process, visit the [Solana Mobile docs site](https://docs.solanamobile.com/dapp-publishing/intro).

# Getting started
# Installation

## 1. Read the publisher policies
Please run the CLI with Node version 18 or greater.

We’ve created the Solana dApp Store to be the best home for Web3 and crypto apps. Our [policies](docs/PUBLISHER-POLICY.md) exist to protect users from illegal, harmful, and misleading content, without restricting the abilities of apps to use crypto features, like trading NFTs or other digital goods.
```shell
corepack enable
corepack prepare pnpm@`npm info pnpm --json | jq -r .version` --activate
```

All apps submitted to the Solana dApp Store must comply with these policies. If you have concerns about an app in the Solana dApp Store catalog, please report it to [[email protected]](mailto:[email protected]).
If you don't have [jq](https://stedolan.github.io/jq/), you can manually get the current version of pnpm with `npm info pnpm` and setup like this:

## 2. Read the Solana dApp Store Developer Agreement
```shell
corepack prepare [email protected] --activate
```

Make sure to read and understand the [Solana dApp Store Developer Agreement](docs/DEVELOPER-AGREEMENT.pdf). These terms apply to all submissions made to the Solana dApp Store publisher portal.
```shell
mkdir publishing
cd publishing

## 3. Publish
pnpm init
pnpm install --save-dev @solana-mobile/dapp-store-cli
npx dapp-store init
npx dapp-store --help
```

Publishing your app to the Solana dApp Store involves two steps - minting NFTs representing your app on-chain, and submitting a request to the publisher portal to have your app listed in the catalog.
# License

Check out the [publishing walkthrough guide](docs/PUBLISHING.md) for step-by-step instructions on how to mint an app’s NFTs and submit publisher portal requests.

## 4. Wait for a decision on your app

After submitting, we’ll review your app against our [policies](docs/PUBLISHER-POLICY.md). Please make sure to provide a valid email address, so that we can reach out to you with any questions about your submission.

# Learn more

## Frequently asked questions

We all have questions - some of them might even be answered in our [FAQ](docs/FAQ.md). If not, don’t despair - check out the [Get support](#get-support) section below and get in touch with the Solana Mobile community and team.

## Building apps

Building apps for Saga starts just like building any other app for Android, whether that be a [native app with Kotlin or Java](https://developer.android.com/), a cross-platform app with [React Native](https://reactnative.dev/), or another framework. Check out [solanamobile.com/developers](http://solanamobile.com/developers) or our [Discord](#discord) for more details.

## Technical details

Want to know how your app is represented on-chain by NFTs? Check out the [specification](publishing-spec/SPEC.md).

# Get support

## Discord

Come chat with us on our [Discord](https://discord.gg/solanamobile) in the `#dapp-store` channel

## Publisher support

If you have a specific question about your app, you can email us at [[email protected]](mailto:[email protected]).
Apache 2.0
32 changes: 0 additions & 32 deletions docs/ABOUT.md

This file was deleted.

Binary file removed docs/DEVELOPER-AGREEMENT.pdf
Binary file not shown.
20 changes: 0 additions & 20 deletions docs/FAQ.md

This file was deleted.

53 changes: 0 additions & 53 deletions docs/PUBLISHER-POLICY.md

This file was deleted.

Loading

0 comments on commit 04df00c

Please sign in to comment.