Merged PR posit-dev/positron-python#105: add our own github readme

Merge pull request #105 from posit-dev/add-positron-readme

add our own github readme
--------------------
Commit message for posit-dev/positron-python@141e61b:

add our own github readme


Authored-by: Wasim Lorgat <[email protected]>
Signed-off-by: Wasim Lorgat <[email protected]>

Author: seeM

extensions/positron-python/.github/README.md

@@ -0,0 +1,25 @@
+# Positron Python Extension
+
+The Python Extension to the [Positron IDE](https://github.com/rstudio/positron).
+
+You can read more about Positron IDE development on the [Positron Wiki](https://connect.rstudioservices.com/positron-wiki).
+
+## About
+
+The extension is a fork of [Microsoft's Python VSCode extension](https://github.com/microsoft/vscode-python). The main TypeScript functionality (mostly UI) is implemented in [`src`](../src) and calls out to Python scripts in [`pythonFiles`](../pythonFiles).
+
+We provide a custom Positron Python Kernel based on the following open source Python projects:
+
+- [**IPyKernel**](https://github.com/ipython/ipykernel), a Jupyter kernel for the Python programming language written in Python
+- [**Jedi Language Server**](https://github.com/pappasam/jedi-language-server), a language server built on the [pygls](https://github.com/openlawlibrary/pygls) (Python Generic Language Server Framework) using the [Jedi](https://github.com/davidhalter/jedi) library for autocompletion, static analysis, and refactoring
+
+The entrypoint to our kernel is the [`positron_language_server.py`](../pythonFiles/positron_language_server.py) script. The core functionality of the kernel can be found in the [`positron`](../pythonFiles/positron/) package, which consists of these services:
+
+- [`positron_ipkernel`](../pythonFiles/positron/positron_ipkernel.py), the Positron Python Kernel
+- [`positron_jedilsp`](../pythonFiles/positron/positron_jedilsp.py), the Positron Python Language Server
+- [`environment`](../pythonFiles/positron/environment.py), manages Positron's Environment pane
+- [`lsp`](../pythonFiles/positron/lsp.py), manages the language server
+- [`plots`](../pythonFiles/positron/plots.py), a custom [IPython display publisher](https://github.com/ipython/ipython/blob/main/IPython/core/displaypub.py) that displays to Positron's Plots pane
+- [`dataviewer`](../pythonFiles/positron/dataviewer.py), manages Positron's Data Viewer
+
+The `environment`, `lsp`, `plots`, and `dataviewer` services communicate with the `positron_ipkernel` via Jupyter's [comms](https://connect.rstudioservices.com/content/59a1f153-dcd8-44ac-849b-3371829b7002/positron-architecture.html#comms-and-ui-bindings) messaging protocol.