Initial commitv1.0.0

1 files changed, 36 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..fdd336a
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,36 @@
+## Features
+
+- adds a metabox to configurable Post-Types to create and edit Twig templates
+- adds Twig support to the WP Theme & Plugin editors
+  - you can even customize the CodeMirror theme
+
+## Plugin Dependencies
+
+- https://wordpress.org/plugins/timber-library/
+- https://wordpress.org/plugins/classic-editor/
+
+## How to use the MetaBox Feature
+
+The plugin uses the path defined in `Timber::$locations` as the templates path or falls back to the uploads folder if none is provided.
+
+Either adjust your `Timber::render('page.twig', $context)`-functions like this:
+```
+$filenames = [TimberEditor::getTemplateFilename(), 'page.twig'];
+Timber::render($filenames, $context);
+```
+
+like this
+```
+TimberEditor::render('page.twig', $context);
+# 'page.twig' serves as a fallback if the current posts's template doesn't exist
+```
+
+or like this
+```
+TimberEditor::renderPost('page.twig', $context);
+# renderPost() automatically adds ['post' => new Timber\Post()] to the $context
+```
+
+## License
+
+(GPL v2)[LICENSE]