Skip to content

Commit 5ec6454

Browse files
committed
docs: improve quick start section
Signed-off-by: Vladislav Polyakov <[email protected]>
1 parent a2df125 commit 5ec6454

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

README.md

+12-24
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,18 @@ A modular, modern SDK for working with YDB in JavaScript/TypeScript. Supports qu
2323

2424
## Quick Start
2525

26+
### 1. Run YDB Locally
27+
28+
Start a local YDB instance with Docker: https://ydb.tech/docs/en/quickstart
29+
30+
### 2. Install Required Packages
31+
32+
```sh
33+
npm install @ydbjs/core @ydbjs/query
34+
```
35+
36+
### 3. Connect and Query
37+
2638
```ts
2739
import { Driver } from '@ydbjs/core'
2840
import { query } from '@ydbjs/query'
@@ -104,27 +116,3 @@ try {
104116

105117
- Build all packages: `npm run build`
106118
- Run all tests: `npm test`
107-
- Build a single package: `cd packages/query && npm run build`
108-
- Generate gRPC/protobuf files (for @ydbjs/api): `cd packages/api && npm run generate`
109-
110-
Devcontainer setup includes YDB and Prometheus for local development. See `.devcontainer/` for details.
111-
112-
---
113-
114-
## Contributing
115-
116-
Contributions are welcome! Open issues, submit PRs, and discuss ideas.
117-
118-
---
119-
120-
## License
121-
122-
Licensed under [Apache 2.0](LICENSE).
123-
124-
---
125-
126-
## Links
127-
128-
- [YDB Documentation](https://ydb.tech)
129-
- [GitHub Repository](https://github.com/ydb-platform/ydb-js-sdk)
130-
- [Issues](https://github.com/ydb-platform/ydb-js-sdk/issues)

0 commit comments

Comments
 (0)