From fb4296dff8467a2bacf3d3a9b556544ab8e6fb3d Mon Sep 17 00:00:00 2001
From: He Ma <59237210+hema-ted@users.noreply.github.com>
Date: Tue, 18 Feb 2020 18:01:43 -0600
Subject: [PATCH] add README.md

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..91cbe76
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+## **PyZFS** code repository
+
+**PyZFS** a Python package for first-principles calculations of the spin-spin zero-field-splitting (ZFS) tensor based on wavefunctions obtained from density functional theory (DFT) calculations.
+
+The tutorial and documentation are hosted on [Read the Docs](https://pyzfs-doc.readthedocs.io/en/latest/).
+