summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNate Sesti <33237525+sestinj@users.noreply.github.com>2023-06-01 21:15:03 -0400
committerGitHub <noreply@github.com>2023-06-01 21:15:03 -0400
commit07cb7c6e91a78da6c5e24b62ded2aa7d5d7da102 (patch)
treeb9d3953fcd9e1910145497302bba035fbe73f9c9 /README.md
parent75af2ad952e1137ca3e1d52f92330468bb3f0281 (diff)
parentadd03956e9bc7f2808d59c7316fe8de6c327581b (diff)
downloadsncontinue-07cb7c6e91a78da6c5e24b62ded2aa7d5d7da102.tar.gz
sncontinue-07cb7c6e91a78da6c5e24b62ded2aa7d5d7da102.tar.bz2
sncontinue-07cb7c6e91a78da6c5e24b62ded2aa7d5d7da102.zip
Merge pull request #56 from continuedev/documentation
Documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/README.md b/README.md
index dc1ad7de..0e397b23 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +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
+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)
-Resources
+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)
- [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