Skip to content

Commit 26406f4

Browse files
Update README.md
replaced initial svelt README with README for contributors
1 parent e8c8b1b commit 26406f4

File tree

1 file changed

+10
-29
lines changed

1 file changed

+10
-29
lines changed

docs/README.md

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,19 @@
1-
# create-svelte
1+
# Docs
22

3-
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
3+
## Prereqs
44

5-
## Creating a project
5+
Install [yarn](https://classic.yarnpkg.com/en/docs/install)
66

7-
If you're seeing this, you've probably already done this step. Congrats!
7+
## Running docs server locally
88

9-
```bash
10-
# create a new project in the current directory
11-
npm init svelte
9+
Run
1210

13-
# create a new project in my-app
14-
npm init svelte my-app
11+
```sh
12+
yarn && yarn dev
1513
```
1614

17-
## Developing
15+
The server should start on [localhost:3000](http://localhost:3000/).
1816

19-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
17+
## Contributing
2018

21-
```bash
22-
npm run dev
23-
24-
# or start the server and open the app in a new browser tab
25-
npm run dev -- --open
26-
```
27-
28-
## Building
29-
30-
To create a production version of your app:
31-
32-
```bash
33-
npm run build
34-
```
35-
36-
You can preview the production build with `npm run preview`.
37-
38-
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
19+
PR should target branch [docs-develop](https://github.com/blocknative/web3-onboard/tree/docs-develop)

0 commit comments

Comments
 (0)