summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNate Sesti <33237525+sestinj@users.noreply.github.com>2023-05-28 21:01:55 -0400
committerGitHub <noreply@github.com>2023-05-28 21:01:55 -0400
commitd614719ed437cbce80fe937954e6ef647075a969 (patch)
treeb965ad027a982611738a7e79feb5fdb1a72168ae
parente02da4c8fada20b7e6bdd80d257a868bbd6b0d0f (diff)
downloadsncontinue-d614719ed437cbce80fe937954e6ef647075a969.tar.gz
sncontinue-d614719ed437cbce80fe937954e6ef647075a969.tar.bz2
sncontinue-d614719ed437cbce80fe937954e6ef647075a969.zip
Update README.md
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index dc1ad7de..4c320a8b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,26 @@
# Continue
+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:
+
+```bash
+git clone https://github.com/continuedev/continue && cd continue/extension/scripts && python3 install_from_source.py
+```
+
+## Writing Recipes
+
+See our guides on writing recipes in the documentation.
+
Resources
- [Continue Github Project](https://github.com/orgs/continuedev/projects/1/views/1)