Skip to content

Commit

Permalink
Add Material for MkDocs and initialize docs directory
Browse files Browse the repository at this point in the history
  • Loading branch information
subhashb committed Mar 23, 2024
1 parent 9858579 commit f3e3421
Show file tree
Hide file tree
Showing 4 changed files with 328 additions and 1 deletion.
25 changes: 25 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Protean

*Framework for Event-driven Applications - build to last, batteries included*

---

**Documentation**: <a href="https://docs.proteanhq.com" target="_blank">https://docs.proteanhq.com</a>

**Source Code**: <a href="https://github.com/proteanhq/protean" target="_blank">https://github.com/proteanhq/protean</a>

---

Protean is a DDD and CQRS-based framework that helps you build Event-driven applications.

## Overview

Protean helps you build applications that can scale and adapt to growing requirements without significant rework.

At its core, Protean encourages a Domain-Driven Design (DDD) approach to development, with support for artifacts necessary to express your domain succinctly and precisely. It also allows you to remain agnostic to the underlying technology by keeping implementation details out of view.

Protean can be thought of having three capabilities:

- *Service-Oriented* - Develop your application as one or more subdomains that run independently as Microservices
- *Event-Driven*: - Use events to propagate changes across subdomains or become eventually consistent within a Bounded Context.
- *Adapter-based*: - Use Remain technology-agnostic by exposing Port interfaces to the infrastructure, with multiple adapters supported out of the box.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
site_name: Protean
theme:
name: material
Loading

0 comments on commit f3e3421

Please sign in to comment.