chore: updated readme

kuutsav · Jun 12, 2024 · 1d01417 · 1d01417
1 parent e6153b6
commit 1d01417
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,4 +15,6 @@ Our project follows a specific design language and aesthetic to ensure a cohesiv
 
 ## JavaScript Dependencies
 
-We aim to keep the ui as lightweight and dependency free as possible. If you believe a new dependency is absolutely necessary, please start a discussion by opening an issue or pull request. Include your rationale for the addition and any potential alternatives you've considered.
+We aim to keep the ui as lightweight and dependency free as possible.
+
+If you believe a new dependency is absolutely necessary, please start a discussion by opening an issue or pull request. Include your rationale for the addition and any potential alternatives you've considered.
diff --git a/README.md b/README.md
@@ -76,3 +76,7 @@ $ python leetcomp/parse.py
 - [ ] Sort by Compensation
 - [ ] ~~Search for Companies~~ and Roles
 - [ ] Filters for Yoe, Date, Compensation, Location
+
+## Contributions
+
+PRs as welcome but please go through [CONTRIBUTING.md](CONTRIBUTING.md) before raising a PR.