Skip to content

Commit fe0cc0a

Browse files
committed
docs: update readme
1 parent 4d6bfdd commit fe0cc0a

1 file changed

Lines changed: 16 additions & 33 deletions

File tree

README.md

Lines changed: 16 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,21 @@
1-
# sv
1+
# DevSteps
22

3-
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
3+
DevSteps is a fast, free learning platform that bundles written courses produced entirely by the community. Each module is authored or reviewed by practitioners, helping learners gain the skills they need without barriers.
44

5-
## Creating a project
5+
## Why DevSteps?
6+
- Fast: Jump straight into the topic you want to learn.
7+
- Free: All content is open and accessible at any time.
8+
- Community-led: Lessons are created and curated by developers who use these skills daily.
69

7-
If you're seeing this, you've probably already done this step. Congrats!
10+
## Getting Started
11+
1. Install dependencies with `npm install`.
12+
2. Launch the development server with `npm run dev -- --open`.
813

9-
```sh
10-
# create a new project in the current directory
11-
npx sv create
14+
## Contributing
15+
- Follow the guidelines in `CONTRIBUTING.md` to add new lessons or improve existing ones.
16+
- Share issues for bugs or learning ideas so the community can act on them.
1217

13-
# create a new project in my-app
14-
npx sv create my-app
15-
```
16-
17-
## Developing
18-
19-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
20-
21-
```sh
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-
```sh
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://svelte.dev/docs/kit/adapters) for your target environment.
18+
## Roadmap Highlights
19+
- Organize modules by category for easier discovery.
20+
- Add a community voting flow to validate new submissions.
21+
- Ship learner profiles to track personal progress.

0 commit comments

Comments
 (0)