Created READMEs for packages (#40)

* Add README and a CONTRIBUTING markdowns

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing
+
+TODO

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Typir
+Copyright (c) 2024 TypeFox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +1,20 @@
 # Typir
 
-A structure for generating validity checks associated with types.
+Engineering types for software languages in the web.
+
+## NPM workspace
+
+This repository is a NPM workspace. It contains the following packages:
+
+- [Typir](./packages/typir/README.md) - the core package of Typir
+- [Typir-Langium](./packages/typir-langium/README.md) - a integration of Typir for [Langium](https://github.com/eclipse-langium/langium)
+
+## Contributing
+
+Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+We also have a release process described in [RELEASE.md](./RELEASE.md).
+
+## License
+
+[MIT License](/LICENSE)

examples/lox/package.json

@@ -1,7 +1,7 @@
 {
     "name": "typir-example-lox",
     "displayName": "lox",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "private": true,
     "description": "",
     "author": {
@@ -30,7 +30,7 @@
     "dependencies": {
         "commander": "~12.1.0",
         "langium": "~3.2.0",
-        "typir-langium": "~0.0.1",
+        "typir-langium": "~0.0.2",
         "vscode-languageclient": "~9.0.1",
         "vscode-languageserver": "~9.0.1"
     },

examples/ox/package.json

@@ -1,7 +1,7 @@
 {
     "name": "typir-example-ox",
     "displayName": "ox",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "private": true,
     "description": "",
     "author": {
@@ -30,7 +30,7 @@
     "dependencies": {
         "commander": "~12.1.0",
         "langium": "~3.2.0",
-        "typir-langium": "~0.0.1",
+        "typir-langium": "~0.0.2",
         "vscode-languageclient": "~9.0.1",
         "vscode-languageserver": "~9.0.1"
     },

packages/typir-langium/README.md

@@ -0,0 +1,21 @@
+# Typir integration for Langium
+
+Typir-Langium is a framework for type checking of languages developed with [Langium](https://langium.org).
+
+## Installation
+
+```bash
+npm install typir-langium
+```
+
+## Documentation
+
+Will follow!
+
+## Examples
+
+Look at the examples in the `examples` folder of the repo ([here](../../examples)). There we have some demo projects for you to get started.
+
+## License
+
+[MIT License](/LICENSE)

packages/typir-langium/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typir-langium",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Typir binding for Langium",
   "homepage": "https://typir.org",
   "author": {
@@ -49,6 +49,6 @@
   "bugs": "https://github.com/TypeFox/typir/issues",
   "dependencies": {
     "langium": "~3.2.0",
-    "typir": "~0.0.1"
+    "typir": "~0.0.2"
   }
 }

packages/typir/README.md

@@ -0,0 +1,21 @@
+# Typir
+
+Typir is a framework for type systems and type checking in the web.
+
+## Installation
+
+```bash
+npm install typir
+```
+
+## Documentation
+
+Will follow!
+
+## Examples
+
+Look at the examples in the `examples` folder of the repo ([here](../../examples)). There we have some demo projects for you to get started.
+
+## License
+
+[MIT License](/LICENSE)

packages/typir/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typir",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "General purpose type checking library",
   "homepage": "https://typir.org",
   "author": {