@scalabli🚀

CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+# Code of Conduct
+
+The Code of Conduct is available in the pyscript Governance repo.
+See https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md

README.md

@@ -1 +1,41 @@
-# pyskit
+# PySkit
+
+## What is PySkit
+
+### tl;dr
+PySkit is a Pythonic alternative to Scratch, JSFiddle or other "easy to use" programming frameworks, making the web a friendly, hackable, place where anyone can author interesting and interactive applications.
+
+To get started see [GETTING-STARTED](GETTING-STARTED.md).
+
+For examples see [the pyskit folder](pyskitjs).
+
+### Longer Version
+PySkit is a meta project that aims to combine multiple open technologies to create a framework for users to use Python (and other languages) to create sophisticated applications in the browser. It highly integrates with the way the DOM works in the browser and allows users to add logic, in Python, in a way that feels natural to web as well as Python developers.
+
+## Try PySkit
+
+To try PySkit, import the appropriate pyskit files to your html page with:
+```html
+<link rel="stylesheet" href="https://github.com/scalabli/pyskit/blob/main/pyskit.css" />
+<script defer src="https://github.com/scalabli/pyskit/blob/main/pyskit.js"></script>
+```
+At that point, you can then use PySkit components in your html page. PySkit currently implements the following elements:
+
+* `<py-skit>`: that can be used to define python code that is executable within the web page. The element itself is not rendered to the page and only used to add logic
+* `<py-repl>`: creates a REPL component that is rendered to the page as a code editor and allows users to write code that can be executed
+
+Check out the [pyskitjs/examples](pyskitjs/examples) folder for more examples on how to use it, all you need to do is open them in Chrome.
+
+## How to Contribute
+
+To contribute:
+
+* clone the repo `git clone https://github.com/scalabli/pyskit`
+* cd into the main project folder with `cd pyskitjs`
+* install the dependencies with `npm install` - make sure to use nodejs version >= 16
+* run `npm run dev` to build and run the dev server. This will also watch for changes and rebuild when a file is saved
+
+* This is an extremely experimental project, so expect things to break!
+* PySkit has been only tested on Chrome, at the moment.
+
+