docs: add contributor notice to core doc

aidenybai · Jan 31, 2021 · 7dc1e8e · 7dc1e8e
1 parent 986c37e
commit 7dc1e8e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing
 
-The issue tracker is only for bug reports and enhancement suggestions. 
+The issue tracker is only for bug reports and enhancement suggestions.
 
 If you wish to contribute to the Lucia codebase or documentation, feel free to fork the repository and submit a
 pull request. We use Prettier to enforce a consistent coding style, so having that set up in your editor of choice
@@ -14,3 +14,7 @@ To get ready to work on the codebase, please do the following:
 2. Run `npm install`
 3. Code your heart out!
 4. [Submit a pull request](https://github.com/aidenybai/lucia/compare) (Make sure you follow the [conventional commit format](https://github.com/aidenybai/lucia/blob/master/.github/COMMIT_CONVENTION.md))
+
+## Lucia Core
+
+Before contributing to Lucia's core, be sure to read this [markdown document](https://github.com/aidenybai/lucia/tree/master/src/core#readme).
diff --git a/src/core/README.md b/src/core/README.md
@@ -35,7 +35,9 @@ The Lucia' core is designed to accomplish a balance between being **fast and com
 
 ## Overview
 
-![Flowchart Overview](https://raw.githubusercontent.com/aidenybai/lucia/master/.github/img/flowchart.svg)
+<p align="center"><img src="https://raw.githubusercontent.com/aidenybai/lucia/master/.github/img/flowchart.svg" alt="Diagram of build pipeline" width="752"></p>
+
+Lucia's Core is composed of two phases: compilation and runtime.
 
 ### Compiler