1 files changed, 38 insertions, 0 deletions
diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..240e635
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,38 @@
+Пример использования:
+```typst
+#import "conf.typ" : conf
+#show: conf.with(
+  title: [Тема работы],
+  type: "referat",
+  info: (
+      author: (
+        name: [Григорьева Данилы Евгеньевича],
+        faculty: [КНиИТ],
+        group: "151",
+        sex: "male"
+      ),
+      inspector: (
+        degree: "доцент, к. ф.-м. н.",
+        name: "С. В. Миронов"
+      )
+  ),
+  settings: (
+    title_page: (
+      enabled: true
+    ),
+    contents_page: (
+      enabled: true
+    )
+  )
+)
+```
+
+На текущий момент частично или полностью поддерживаются следующие типы работ:
++ Реферат (полная поддержка): referat
++ Курсовая работа (приоритетное направление): coursework
++ Выпускная квалификационная работа: diploma
++ Автореферат: autoref
++ Отчёт о научно-исследовательской работе: nir
++ Отчёт о практике (приоритетное направление): pract
+
+Шаблон находится в стадии разработки и стремится быть максимально приближенным к шаблону LaTeX от Сергея Владимировича.