summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 33 insertions, 6 deletions
diff --git a/README.md b/README.md
index 18525fcd..0e397b23 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,41 @@
+![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+![GitHub Repo stars](https://img.shields.io/github/stars/continuedev/continue?style=social)
+![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fcontinuedev%2Fcontinue)
+
# Continue
-Try out latest version:
+Continue is the open-source autopilot for software developers. Using our SDK you can write short scripts, called recipes, that automate sequences of tasks that are common within your codebase. This repository contains:
+
+- The Continue Python package, which offers an SDK to write recipes and the Continue server, which runs all automations
+- The Continue VSCode extension, where you can natively run recipes and use natural language to refine code much faster
+
+## Getting Started
+
+The easiest way to start using Continue is to download our VS Code extension from the marketplace:
+
+[Download for VS Code](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
+
+Alternatively, you can build from source. Just clone the repo and run a Python script:
-- `cd extension`
-- `npm run package`
-- `cd build`
-- `code --install-extension continue-0.0.1.vsix`
+```bash
+git clone https://github.com/continuedev/continue && cd continue/extension/scripts && python3 install_from_source.py
+```
-Resources
+## Writing Recipes
+
+See our guides on writing recipes in the documentation.
+
+# Resources
- [Continue Github Project](https://github.com/orgs/continuedev/projects/1/views/1)
- [Continue User Guide](https://www.notion.so/continue-dev/Continue-User-Guide-1c6ad99887d0474d9e42206f6c98efa4)
- [Continue - Mission & Vision](https://continue-dev.notion.site/Continue-a8e41af9801641f79d2c8565907bbd22)
+
+# Contributing
+
+Please do
+
+# License
+
+[Apache-2.0]([https://github.com/sestinj/the-x/blob/main/LICENSE](https://opensource.org/licenses/Apache-2.0)) © 2023 Continue