docs: 📝 added repo docs

CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[arctic_hen7@pm.me](mailto:arctic_hen7@pm.me).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+First off, thanks so much for taking the time to contribute to Perseus, it's greatly appreciated!
+
+## I just want to propose something
+
+If you just want to let us know about a bug, or propose a new feature, please [open an issue](https://github.com/arctic-hen7/perseus/issues/new/choose) on this repository. We'll take a look as soon as possible!
+
+## I want to help
+
+That's fantastic! You can check out the [roadmap](./README.md#Roadmap) or the [issues](https://github.com/arctic-hen7/perseus/issues) to see what's currently needing to be done. If you want to work on something that's not on there, please [file an issue](https://github.com/arctic-hen7/perseus/issues/new/choose) and we'll take a look it as soon as possible!
+
+## How do I contribute?
+
+Contributing to a project on Github is pretty straight forward. If this is you're first time contributing to a project, all you need to do is fork this repository to your own GitHub account, add then change the code you want to (usually on your local machine, you'd pull your fork down). Commit your changes as necessary, and when you're done, submit a pull request on this repository and we'll review it as soon as possible!
+
+Make sure your code doesn't break anything existing, that all tests pass, and, if necessary, add tests so your code can be confirmed to work automatically.
+
+After you've submitted a pull request, a maintainer will review your changes. Unfortunately, not every pull request will be merged, but we'll try to request changes so that your pull request can best be integrated into the project.
+
+## Building and Testing
+
+Perseus uses [Bonnie](https://github.com/arctic-hen7/bonnie) for command aliasing, and most of the project work is done on the `showcase` example, which is used for live development testing.
+
+- Terminal 1
+	- `cd examples/showcase`
+	- `bonnie build --watch`
+- Terminal 2
+	- `cd examples/showcase`
+	- `bonnie serve`
+
+Now you can make changes to the core library and enjoy! Nearly all project commands are managed with Bonnie, and you can see what everything does by checking out the various `bonnie.toml` files throughout the project!
+
+## Documentation
+
+If the code you write needs to be documented in, the README, the book, or elsewhere, please do so! Also, **please ensure your code is commented**, it makes everything so much easier.
+
+## Committing
+
+We use the Conventional Commits system, but you can commit however you want. Your pull request will be squashed and merged into a single compliant commit, so don't worry about this!

README.md

@@ -1,11 +1,62 @@
-# Perseus
+<h1 style="text-align: center;">Perseus</h1>
 
-> 🚧 Perseus is still under active development! Please use it with caution at this early stage! 🚧
+[Book][book] • [Crate Page][crate] • [API Documentation][docs] • [Contributing][contrib]
 
-Perseus is a frontend web development library for Rust with full support for SSR, SSG, and ISR. It wraps the excellent lower-level systems of [Sycamore](https://github.com/sycamore-rs/sycamore), adding a more familiar NextJS-like API for SSR/SSG while maintaining maximum customizability.
+> 🚧 Perseus is **nearly** ready for v0.1.0, but is still under construction! 🚧
 
-TODO
+Perseus is a blazingly fast frontend web development framework built in Rust with support for major rendering strategies, reactivity without a virtual DOM, and extreme customizability. It wraps the lower-level capabilities of [Sycamore](https://github.com/sycamore-rs/sycamore) and provides a NextJS-like API!
+
+- ✨ Supports static generation (serving only static resources)
+- ✨ Supports server-side rendering (serving dynamic resources)
+- ✨ Supports revalidation after time and/or with custom logic (updating rendered pages)
+- ✨ Supports incremental regeneration (build on demand)
+- ✨ Open build matrix (use any rendering strategy with anything else, mostly)
+
+## How to use
+
+Check out the docs [here](https://arctic-hen7.github.io/perseus) (WORK IN PROGRESS!) for how to use Perseus.
+
+## Aim
+
+Support every major rendering strategy and provide developers the ability to efficiently create super-fast apps with Rust and a fantastic developer experience!
+
+## Motivation
+
+There is a sore lack of Rust frameworks for frontend development that support more than just SPAs and client-side rendering, and so Perseus was born. We need something like NextJS for WASM.
+
+## Roadmap
+
+### Pre-beta
+
+These tasks still need to be done before Perseus can be pushed to v0.1.0.
+
+- [ ] Support providing request data to SSR renderers
+
+### Pre-stable
+
+These tasks still need to be done before Perseus can be pushed to v1.0.0.
+
+- [ ] Support custom template hierarchies
+- [ ] Create a custom CLI as a harness for apps without riediculous amounts of configuration needed
+- [ ] Support i18n out of the box
+- [ ] (Maybe) Implement custom router
+- [ ] Pre-built integrations for Actix Web and AWS Lambda
+
+### Beyond
+
+These tasks will be done after Perseus is stable.
+
+- [ ] Integrations for other platforms
+
+## Contributing
+
+We appreciate all kinds of contributions, check out our [contributing guidelines](./CONTRIBUTING.md) for more information! Also, please be sure to follow our [code of conduct](./CODE_OF_CONDUCT.md).
 
 ## License
 
 See [`LICENSE`](./LICENSE).
+
+[book]: https://arctic-hen7.github.io/perseus
+[crate]: https://crates.io/crates/perseus
+[docs]: https://docs.rs/perseus
+[contrib]: ./CONTRIBUTING.md