Adds README to packages

kettanaito · Dec 6, 2019 · e6ab8b9 · e6ab8b9
1 parent 8a463ce
commit e6ab8b9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/atomic-layout-core/README.md b/packages/atomic-layout-core/README.md
@@ -0,0 +1,7 @@
+# `@atomic-layout/core`
+
+Core functionality of the [Atomic Layout][atomic-layout] library.
+
+> **Please note that as a user of Atomic Layout you are not supposed to use this package directly in your application.** It serves as a logic abstraction for various rendering implementations (with styled-components, emotion, etc.). Use this package if you are planning to introduce a new rendering implementation of Atomic Layout.
+
+[atomic-layout]: https://github.com/kettanaito/atomic-layout
diff --git a/packages/atomic-layout/README.md b/packages/atomic-layout/README.md