Merge pull request #56 from continuedev/documentation

Documentation

2 files changed, 43 insertions, 15 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
diff --git a/continuedev/README.md b/continuedev/README.md
index 5658e8de..a1ddb084 100644
--- a/continuedev/README.md
+++ b/continuedev/README.md
@@ -1,27 +1,23 @@
-# Continue
+# Continue PyPI Package
 
 Continue is a Python library for automating repetitive sequences of software development tasks using language models. Using our VS Code extension, you can build, run, and refine these recipes as they natively interact with your codebase. Download on [our GitHub](https://github.com/continuedev/continue).
 
-## Steps to start
+## Continue Server
 
-- `cd continue/continue`
+The Continue server acts as a bridge between the Continue React app and your IDE, running your recipes and acting on the codebase. Start it by running the following commands:
+
+- `cd continuedev`
 - Make sure packages are installed with `poetry install`
 - `poetry shell`
 - `cd ..`
-- `python3 -m continuedev.src.continuedev`
-
-## Steps to generate JSON Schema
-
-Same up until last step and then `python3 -m continuedev.src.scripts.gen_json_schema`.
-
-## Start the server
+- `python3 -m continuedev.src.continuedev.server.main`
 
-Same steps, then `uvicorn continue.src.server.main:app --reload`.
+## Scripts
 
-## To build
+`poetry run typegen` to generate JSONSchema .json files from the Pydantic types defined in the `models` directory.
 
-Run `poetry build` and it will output wheel and tarball files in `./dist`.
+`poetry build` will output wheel and tarball files in `./dist`.
 
 ## Writing Steps
 
-See the `src/continuedev/libs/steps` folder for examples of writing a Continue step.
+See the `src/continuedev/libs/steps` folder for examples of writing a Continue step. See our documentation for tutorials.