Add README and LICENSE

Author: LilyFoote

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) Lily Foote and other contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of Django nor the names of its contributors may be used
+       to endorse or promote products derived from this software without
+       specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,48 @@
+# Django Rusty Templates
+
+Django Rusty Templates is an experimental reimplementation of Django's templating language in Rust.
+
+## Goals
+
+* 100% compatibility of rendered output.
+* Error reporting that is at least as useful as Django's errors.
+* Improved performance over Django's pure Python implementation.
+
+## Installation
+
+Django Rusty Templates is not yet ready for full release, so it is not available on PyPI yet. Instead it can be installed from github or from a local clone:
+
+```sh
+$ pip install git+https://github.com/LilyFoote/django-rusty-templates.git
+```
+
+```sh
+
+$ git clone git@github.com:LilyFoote/django-rusty-templates.git
+$ pip install ./django-rusty-templates
+```
+
+You will need a rust compiler installed (https://rustup.rs/).
+
+## Usage
+
+Add an entry to your [`TEMPLATES` setting](https://docs.djangoproject.com/en/5.1/ref/settings/#std-setting-TEMPLATES) with `"BACKEND"` set to `"django_rusty_templates.RustyTemplates"`:
+
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django_rusty_templates.RustyTemplates",
+        ... # Other configuration options
+    },
+]
+```
+
+## Contributing
+
+Django Rusty Templates is open to contributions. These can come in many forms:
+
+* Implementing missing features, such as filters and tags built into Django.
+* Reporting bugs where Django Rusty Templates gives the wrong result.
+* Adding new test cases to ensure Django Rusty Templates behaves the same as Django.
+* Adding benchmarks to track performance.
+* Refactoring for readability or performance.