From dfa834be68bb87d1000d84109b14b094cebd7e6a Mon Sep 17 00:00:00 2001 From: Roberto Prevato Date: Tue, 3 Jan 2023 19:18:26 +0100 Subject: [PATCH] Update CHANGELOG, README --- CHANGELOG.md | 9 ++++----- README.md | 12 +++++++----- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cfa87cec..80595932 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,11 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [2.0.0] - ??? -- Renames the web framework to "Neoteroi" and the package to `neoteroi-web`, - to adopt PEP 420 and offer a more consistent experience when used with its - related libraries. The name BlackSheep will still used as project name for - some time. -- Renames the `plugins` namespace to `settings` +- Renames the web framework package to `neoteroi-web`, to adopt PEP 420 and + offer a more consistent experience when used with its related libraries. + The name BlackSheep will still used as project name for some time. +- Renames the `plugins` namespace to `settings`. - Replaces `rodi` with `neoteroi-di`, which includes improvements. - Adds support for alternative implementation of containers for dependency injection, removing direct references to `rodi` (now `neoteroi-di`) in most diff --git a/README.md b/README.md index 756913b7..ba74655f 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,16 @@ [![codecov](https://codecov.io/gh/Neoteroi/BlackSheep/branch/master/graph/badge.svg?token=Nzi29L0Eg1)](https://codecov.io/gh/Neoteroi/BlackSheep) [![license](https://img.shields.io/github/license/Neoteroi/blacksheep.svg)](https://github.com/Neoteroi/blacksheep/blob/main/LICENSE) [![Join the chat at https://gitter.im/Neoteroi/BlackSheep](https://badges.gitter.im/Neoteroi/BlackSheep.svg)](https://gitter.im/Neoteroi/BlackSheep?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![documentation](https://img.shields.io/badge/📖-docs-purple)](https://www.neoteroi.dev/blacksheep/) -# Neoteroi Web -Neoteroi Web is an asynchronous web framework to build event based web +# BlackSheep +BlackSheep is an asynchronous web framework to build event based web applications with Python. It is inspired by [Flask](https://palletsprojects.com/p/flask/), [ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/), and the work by [Yury Selivanov](https://magic.io/blog/uvloop-blazing-fast-python-networking/). +BlackSheep is the project name of the web framework in Neoteroi. With the +second version of the framework, the Python package is renamed from `blacksheep` to `neoteroi-web`. +

Black Sheep

@@ -19,9 +22,8 @@ Selivanov](https://magic.io/blog/uvloop-blazing-fast-python-networking/). pip install neoteroi-web ``` -`neoteroi-web` is the new version of the library previously named -[`blacksheep`](https://pypi.org/project/blacksheep/). It is currently `alpha` and still -subject to change. +The first version of the web framework is available as [`blacksheep`](https://pypi.org/project/blacksheep/) and is not going to be _willingly_ modified in non-backward compatible ways (it is stable). +`neoteroi-web` is currently `alpha` and still subject to change. ---