Skip to content

Commit

Permalink
Update documentation index
Browse files Browse the repository at this point in the history
  • Loading branch information
tarsil committed Oct 9, 2023
1 parent 8bb659e commit e95aecc
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/1-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,10 @@ We can then decide if the discussion needs to be escalated into an "Issue" or no

This will make sure that everything is organised properly.
---

**Esmerald version**:
**Python version**:
**OS**:
**Platform**:

<!-- Enter your issue details below this comment and as much detail as possible. -->
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Esmerald

<p align="center">
<a href="https://esmerald.dymmond.com"><img src="https://res.cloudinary.com/dymmond/image/upload/v1673619342/esmerald/img/logo-gr_z1ot8o.png" alt='Esmerald'></a>
<a href="https://esmerald.dev"><img src="https://res.cloudinary.com/dymmond/image/upload/v1673619342/esmerald/img/logo-gr_z1ot8o.png" alt='Esmerald'></a>
</p>

<p align="center">
Expand All @@ -28,6 +28,8 @@

**Source Code**: [https://github.com/dymmond/esmerald](https://github.com/dymmond/esmerald)

**The official supported version is always the latest released**.

---

Esmerald is a modern, powerful, flexible, high performant, web framework designed to build not only APIs
Expand All @@ -36,7 +38,9 @@ but also full scalable applications from the smallest to enterprise level.
Esmerald is designed to build with python 3.8+ and based on standard python type hints and on the top of
the heavily known [Starlette](https://github.com/encode/starlette) and [Pydantic](https://github.com/samuelcolvin/pydantic).

Check out the [Esmerald documentation 📚](https://esmerald.dymmond.com)
Check out the [Esmerald documentation 📚](https://esmerald.dev)

**The official supported version is always the latest released**.

## Motivation

Expand Down Expand Up @@ -133,7 +137,7 @@ $ pip install esmerald[test]

Or you can skip this step if you don't want to use the EsmeraldTestClient.

You can find [more information](https://esmerald.dymmond.com/management/directives) about this directive and how to
You can find [more information](https://esmerald.dev/management/directives) about this directive and how to
use it.

## Key Features
Expand Down
5 changes: 4 additions & 1 deletion docs/esmerald.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Esmerald

<p align="center">
<a href="https://esmerald.dymmond.com"><img src="https://res.cloudinary.com/dymmond/image/upload/v1673619342/esmerald/img/logo-gr_z1ot8o.png" alt='Esmerald'></a>
<a href="https://esmerald.dev"><img src="https://res.cloudinary.com/dymmond/image/upload/v1673619342/esmerald/img/logo-gr_z1ot8o.png" alt='Esmerald'></a>
</p>

<p align="center">
Expand Down Expand Up @@ -36,6 +36,9 @@ but also full scalable applications from the smallest to enterprise level.
Esmerald is designed to build with python 3.8+ based on standard python type hints and on the top of
the heavily known [Starlette](https://github.com/encode/starlette) and [Pydantic](https://github.com/samuelcolvin/pydantic).

!!! Success
**The official supported version is always the latest released**.

## Motivation

There are great frameworks out there like FastAPI, Starlite, Flama, Flask, Django... All of them solving majority
Expand Down

0 comments on commit e95aecc

Please sign in to comment.