Skip to content

Commit fdc727d

Browse files
committed
docs: update readme
1 parent 151092e commit fdc727d

File tree

2 files changed

+17
-22
lines changed

2 files changed

+17
-22
lines changed

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
22

3-
![Deepnote Toolkit cover image](./assets/deepnote-vscode-cover-image.png)
3+
![Deepnote VSCode cover image](./assets/deepnote-vscode-cover-image.png)
44

55
[![CI](https://github.com/deepnote/vscode-deepnote/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/deepnote/vscode-deepnote/actions/workflows/ci.yml)
66
[![codecov](https://codecov.io/gh/deepnote/vscode-deepnote/graph/badge.svg?token=NH066XG7JC)](https://codecov.io/gh/deepnote/vscode-deepnote)
@@ -19,13 +19,13 @@ A powerful [Visual Studio Code](https://marketplace.visualstudio.com/items?itemN
1919

2020
Run Deepnote locally inside your IDE and unlock the next generation of data workflows:
2121

22-
- **Rich block types** Combine Python, Markdown, data visualizations, tables, and more — all in one place
23-
- **SQL blocks** Run SQL queries out of the box, no extensions needed
24-
- **Native database connections** Securely connect to Snowflake, BigQuery, Postgres, and 60+ other sources via VS Code’s encrypted SecretStorage API
25-
- **Init notebooks** Auto-run setup code (dependencies, env setup) before execution
26-
- **Smart requirements** Generate `requirements.txt` automatically for reproducible runs
27-
- **Deepnote kernel** Fully `.ipynb` compatible, tuned for modern data workflows
28-
- **Cloud collaboration** Switch between local VS Code and Deepnote Cloud to collaborate live on the same file with your team
22+
- **Rich block types:** Combine Python, Markdown, data visualizations, tables, and more — all in one place
23+
- **SQL blocks:** Run SQL queries out of the box, no extensions needed
24+
- **Native database connections:** Securely connect to Snowflake, BigQuery, Postgres, and 60+ other sources via VS Code’s encrypted SecretStorage API
25+
- **Init notebooks:** Auto-run setup code (dependencies, env setup) before execution
26+
- **Smart requirements:** Generate `requirements.txt` automatically for reproducible runs
27+
- **Deepnote kernel:** Fully `.ipynb` compatible, tuned for modern data workflows
28+
- **Cloud collaboration:** Switch between local VS Code and Deepnote Cloud to collaborate live on the same file with your team
2929

3030
## Getting started
3131

@@ -89,27 +89,22 @@ SELECT * FROM users WHERE created_at > '2024-01-01'
8989

9090
Results are displayed as interactive tables that you can explore and export.
9191

92-
## Quick start for developers
92+
## Need help?
9393

94-
Want to contribute? Check out our [Contributing guide](CONTRIBUTING.md) for detailed setup instructions.
95-
96-
## Documentation
94+
- Join our [Community](https://github.com/deepnote/deepnote/discussions)!
95+
- Open an [Issue](https://github.com/deepnote/vscode-deepnote/issues) for bug reports or feature requests
96+
- Have a look at [Architecture](architecture.md) for technical and design decisions
97+
- Visit [Deepnote kernel implementation](DEEPNOTE_KERNEL_IMPLEMENTATION.md) for the custom Jupyter kernel
98+
- Learn how database integrations work in [Integrations & credentials](INTEGRATIONS_CREDENTIALS.md)
9799

98-
- **[Architecture](architecture.md)** - Technical architecture and design decisions
99-
- **[Deepnote kernel implementation](DEEPNOTE_KERNEL_IMPLEMENTATION.md)** - Details on the custom Jupyter kernel
100-
- **[Integrations & credentials](INTEGRATIONS_CREDENTIALS.md)** - How database integrations work
101-
- **[Contributing guide](CONTRIBUTING.md)** - How to contribute to the project
100+
## Contributing
102101

103-
## Issues & support
104-
105-
- **Bug reports**: [GitHub issues](https://github.com/deepnote/vscode-deepnote/issues)
106-
- **Feature requests**: [GitHub discussions](https://github.com/deepnote/deepnote/discussions)
107-
- **Questions**: [GitHub discussions](https://github.com/deepnote/deepnote/discussions)
102+
Want to contribute? Check out our [Contributing guide](CONTRIBUTING.md) for detailed setup instructions.
108103

109104
---
110105

111106
<div align="center">
112107

113-
Built with 💙 by the data driven team
108+
Built with 💙
114109

115110
</div>
-3.92 KB
Loading

0 commit comments

Comments
 (0)