From 00e5344b2b5a7bf504540395e47600a28312baad Mon Sep 17 00:00:00 2001
From: Pocco81 <pocco451@gmail.com>
Date: Wed, 25 May 2022 12:13:35 -0500
Subject: [PATCH] added contributing

---
 README.md            |  3 ++-
 docs/README.md       |  6 +++++-
 docs/contributing.md | 39 +++++++++++++++++++++++++++++++++++++++
 docs/integration.md  |  0
 docs/specs.md        |  0
 docs/style-guide.md  | 10 ++++++++++
 6 files changed, 56 insertions(+), 2 deletions(-)
 create mode 100644 docs/contributing.md
 create mode 100644 docs/integration.md
 create mode 100644 docs/specs.md
 create mode 100644 docs/style-guide.md

diff --git a/README.md b/README.md
index d759382..830cbc5 100644
--- a/README.md
+++ b/README.md
@@ -31,7 +31,8 @@
 &nbsp;
 
 <p align="center">
-Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of a soothing warm palette with 22 eye-candy colors perfect for coding, designing, and much more! In addition, this repository tracks the development of the actual color palette, organization-wide assets, resources and code samples for maintainers/developers.
+Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of 4 soothing warms palette with 26 eye-candy colors each, perfect for coding, designing, and much more! In addition, this repository tracks the development of the actual color palette, organization-wide assets, resources and code samples for maintainers/developers.
+</p>
 
 <p align="center">
 <a href="https://discord.gg/r6Mdz5dpFc"><img src="assets/social/discord.png" width="100" height="100" alt="Discord Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/> <a href="https://github.com/catppuccin"><img src="assets/social/github.png" width="100" height="100" alt="Github Logo"/></a> <img src="assets/misc/transparent.png" height="1" width="5"/> <a href="https://www.npmjs.com/org/catppuccin"><img src="assets/social/npm.svg" width="100" height="100" alt="Npm Logo"/></a>
diff --git a/docs/README.md b/docs/README.md
index 68bde6a..4a4c822 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -13,11 +13,15 @@
 </h6>
 
 <p align="center">
-	Documentation for Koy, the human-friendly data serialization language
+	Documentation for Catppuccin, the soothing pastel theme for the high-spirited!
 </p>
 
 &nbsp;
 
+<p align="center">
+Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of 4 soothing warms palette with 26 eye-candy colors each, perfect for coding, designing, and much more! In addition, this repository tracks the development of the actual color palette, organization-wide assets, resources and code samples for maintainers/developers.
+</p>
+
 ### 🎏 Koy Lang
 
 Koy is designed to be a minimal, simple and intuitive data serialization language; easy for you, your dog and your average 5 year-old. It has a small set of symbols, not too many rules and only one singular statement. Its lack of complexity makes it the perfect language for your project! easy to implement, debug and modularize.
diff --git a/docs/contributing.md b/docs/contributing.md
new file mode 100644
index 0000000..e779a1d
--- /dev/null
+++ b/docs/contributing.md
@@ -0,0 +1,39 @@
+<p align="center">
+  <h2 align="center">🤝 Contributing</h2>
+</p>
+
+<p align="center">
+	Creating Catppuccin ports
+</p>
+
+&nbsp;
+
+This section covers how to properly create Catppuccin ports and how to submit them!
+
+### What's a port?
+
+A port is basically an adaptation of Catppuccin's palettes for an app to use. Think of it as a colorscheme for a program that styles every UI component it consists of!
+
+### Creation
+
+You can create ports using [this](https://github.com/catppuccin/template) public template as a blueprint. However, you must **not** create it the traditional way (by clicking **Use this template**), because this leaves a _small_ tag under the repos' name that says `generated from <template>`. To avoid this, follow the instructions below:
+
+1. Create the repo and leave it empty
+2. Add this template as a remote: `git remote add template git@github.com:catppuccin/template.git`
+3. Pull from it: `git pull template main --depth=1`
+4. Delete the remote: `git remote remove template`
+
+### Styling!
+
+Although you just created the repo successfully, it's important to style properly to ensure consistency:
+
+-   The name of the repo must be the simplest version of the app's name (e.g `nvim` instead of `NeoVim`)
+-   Put the images under `assets/`. If there are a bunch of them consider [creating an empty branch](https://gist.github.com/joncardasis/e6494afd538a400722545163eb2e1fa5) (e.g. `assets`) and storing them there.
+-   Format the repo's description as "`<allusive emoji>` "Soothing pastel theme for App"
+-   Add `catppuccin` to the topics.
+-   Ensure uppercase meta files (e.g. `README.md`)
+-   Don't add health files (e.g. `CODE_OF_CONDUCTS.md`, `SUPPORT.md`), those are organization-wide files stored [here](https://github.com/catppuccin/.github).
+
+#### Submission
+
+Open an issue under the main repo and fill out the information requested on the "[port request](https://github.com/catppuccin/catppuccin/issues/new?assignees=&labels=port+request&template=port-request.md&title=App)". It's recommended to also share the port in our [Discord server](https://discord.gg/r6Mdz5dpFc) beforehand so that other members of the community can give their opinion on it and hopefully improve it.
diff --git a/docs/integration.md b/docs/integration.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/specs.md b/docs/specs.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/style-guide.md b/docs/style-guide.md
new file mode 100644
index 0000000..f15cf21
--- /dev/null
+++ b/docs/style-guide.md
@@ -0,0 +1,10 @@
+<p align="center">
+  <h2 align="center">🖌️ Style Guide</h2>
+</p>
+
+
+<p align="center">
+	A guide on how to properly <i>use</i> the palettes
+</p>
+
+&nbsp;