From 7658a3ff0bed1b3f03e97f8f61519c3648eaaecf Mon Sep 17 00:00:00 2001
From: Ian Clarke <ian.clarke@fullscript.com>
Date: Mon, 20 Jun 2022 13:06:39 -0400
Subject: [PATCH 1/3] Main first commit of README

---
 README.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 74 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 73709ba6..53805cb6 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,74 @@
-Testing
+# [Aviary Tokens](https://aviary.docs.fullscript.cloud/)
+
+Aviary tokens are foundational design primitives used in our [Aviary Design System](https://aviary.docs.fullscript.cloud/).
+
+Design tokens originated at Salesforce, and the best way to describe them is to simply quote their documentation:
+
+> Design tokens are the visual design atoms of the design system — specifically, they are named entities that store visual design attributes. We use them in place of hard-coded values (such as hex values for color or pixel values for spacing) in order to maintain a scalable and consistent visual system for UI development – [Salesforce UX](https://www.lightningdesignsystem.com/design-tokens/)
+
+### Installation
+
+Add the following dependency to your `package.json` file:
+
+```js
+"dependencies": {
+  "aviary-tokens": "https://github.com/Fullscript/aviary-tokens.git#main",
+}
+```
+
+### Upgrading
+
+Since this repository does not have an [NPM Package](https://www.npmjs.com/) associated with it, upgrading is done manually using [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) and [GitHub releases](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
+
+In order to target a new release, simply specify the release number after the Git repository within `package.json`:
+
+```js
+"dependencies": {
+  "aviary-tokens": "https://github.com/Fullscript/aviary-tokens.git#0.2",
+}
+```
+
+You can also target a specific branch for testing, using in the same format:
+
+```js
+"dependencies": {
+  "aviary-tokens": "https://github.com/Fullscript/aviary-tokens.git#my-branch",
+}
+```
+
+### Usage
+
+1.  Determine which platform/language you are targeting
+
+We currently support two platforms:
+
+- Typescript (for React/React Native projects)
+- SCSS (For projects that do not use CSS-in-JS)
+
+2.  Import the package for use:
+
+For React projects:
+
+```js
+import { Typography } from "aviary-tokens/ts";
+```
+
+For SCSS projects:
+
+TODO: Verify this part lol
+
+```scss
+@import "aviary-tokens/scss";
+```
+
+3.  Use the tokens!
+
+### Resources
+
+Our Design tokens in Figma: [Foundations](https://www.figma.com/file/ed7GjnB5rfEQ1CdTTh9jFP/Foundations?node-id=399%3A398)
+
+## Contributing
+
+TODO: Fix this up and add CONTRIBUTING.md
+
+Pull requests are welcome. See the [contribution guidelines](https://github.com/Fullscript/aviary-tokens/blob/main/.github/CONTRIBUTING.md) for more information.

From eae194c1eb2d0e7d215fec1fcb404c42168a714e Mon Sep 17 00:00:00 2001
From: Ian Clarke <ian.clarke@fullscript.com>
Date: Mon, 20 Jun 2022 13:13:41 -0400
Subject: [PATCH 2/3] Useage

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 53805cb6..f0715cd2 100644
--- a/README.md
+++ b/README.md
@@ -63,6 +63,18 @@ TODO: Verify this part lol
 
 3.  Use the tokens!
 
+TODO: Fill our/fix up once we're using
+
+### React:
+
+```js
+import { typography } from "aviary-tokens/ts";
+
+export const myStyles = css`
+  font-size: ${typography.h1.fontSize};
+`;
+```
+
 ### Resources
 
 Our Design tokens in Figma: [Foundations](https://www.figma.com/file/ed7GjnB5rfEQ1CdTTh9jFP/Foundations?node-id=399%3A398)

From 06c4d58a0ebec7f29bbba124b18fece1877a7ddd Mon Sep 17 00:00:00 2001
From: Ian Clarke <ian.clarke@fullscript.com>
Date: Tue, 21 Jun 2022 10:20:12 -0400
Subject: [PATCH 3/3] H2 to H3

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f0715cd2..6ff88a32 100644
--- a/README.md
+++ b/README.md
@@ -79,7 +79,7 @@ export const myStyles = css`
 
 Our Design tokens in Figma: [Foundations](https://www.figma.com/file/ed7GjnB5rfEQ1CdTTh9jFP/Foundations?node-id=399%3A398)
 
-## Contributing
+### Contributing
 
 TODO: Fix this up and add CONTRIBUTING.md