From 4aa9962654feaede2a1ddd2f353eeed3bb887a42 Mon Sep 17 00:00:00 2001 From: Raphael Moreira Date: Fri, 20 Oct 2023 18:03:18 -0300 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 8f9b57d..a462415 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,27 @@ [![Lensophy](https://dev.azure.com/raphaelmoreira/758a305a-a7fa-4b96-95aa-962c2cf2248c/_apis/git/repositories/27fc1054-4851-4e6d-af8a-a463841dc8c1/items?path=/lensophy-banner.png&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream)](https://raphaelmoreira.github.io/lensophy/) -๐Ÿ‡บ๐Ÿ‡ธ | [๐Ÿ‡ง๐Ÿ‡ท](Readme.pt-BR.md) - -# Lensophy - Respectful Communication -Based on philosophical principles of ethics and virtue, Lensophy acts as an observational lens, providing users with the opportunity to reconsider and rephrase messages that may contain verbal aggression before sending them. - +![](https://img.shields.io/badge/Version-v1.0.0-blue) +![](https://img.shields.io/badge/Status-Released-blue) +![](https://img.shields.io/github/license/raphaelmoreira/lensophy) +![Nuget](https://img.shields.io/nuget/dt/lensophy) [![Lensophy last build](https://github.com/raphaelmoreira/lensophy/actions/workflows/dotnet.yml/badge.svg?branch=main)](https://github.com/raphaelmoreira/lensophy/actions/workflows/dotnet.yml) [![Deploy static content to Pages](https://github.com/raphaelmoreira/lensophy/actions/workflows/static.yml/badge.svg)](https://github.com/raphaelmoreira/lensophy/actions/workflows/static.yml) -![GitHub issues](https://img.shields.io/github/issues/raphaelmoreira/lensophy) -[![Percentage of issues still open](https://isitmaintained.com/badge/open/raphaelmoreira/lensophy.svg)](https://isitmaintained.com/project/raphaelmoreira/lensophy "Percentage of issues still open") -[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/raphaelmoreira/lensophy.svg)](https://isitmaintained.com/project/raphaelmoreira/lensophy "Average time to resolve an issue") -![GitHub tag checks state](https://img.shields.io/github/checks-status/raphaelmoreira/lensophy/v0.0.0-beta.7) -![Nuget](https://img.shields.io/nuget/dt/lensophy) -![](https://img.shields.io/github/license/raphaelmoreira/lensophy) +๐Ÿ‡บ๐Ÿ‡ธ | [๐Ÿ‡ง๐Ÿ‡ท](Readme.pt-BR.md) -![GitHub milestone details](https://img.shields.io/github/milestones/progress/raphaelmoreira/lensophy/1) -![GitHub repo size](https://img.shields.io/github/repo-size/raphaelmoreira/lensophy) -![GitHub watchers](https://img.shields.io/github/watchers/raphaelmoreira/lensophy) +# Lensophy - Respectful Communication +Based on philosophical principles of ethics and virtue, Lensophy acts as an observational lens, providing users with the opportunity to reconsider and rephrase messages that may contain verbal aggression before sending them. # TL;DR; If you prefer to understand through practice, go straight to the [Getting Started](https://github.com/raphaelmoreira/lensophy/tree/main/src/Lensophy/Doc#getting-started), otherwise, continue. # How it works? - This API provides developers with the ability to enhance their comment systems (such as forums, blogs, or websites) by analyzing, filtering, and encouraging good behavior through suggested responses that guide towards a friendly perspective rather than censoring it. [![How to use it](https://dev.azure.com/raphaelmoreira/758a305a-a7fa-4b96-95aa-962c2cf2248c/_apis/git/repositories/27fc1054-4851-4e6d-af8a-a463841dc8c1/items?path=/how-to-use-it.png&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream)](#philosophy) -### WARNING! +### Warning! The example above is merely illustrative, acting as a suggestion for use. There are no interfaces or UX flow. This must be done by you. Lensophy just returns an object with suggested message, after analysis. # Concept @@ -44,6 +36,13 @@ Well... thatยดs it. If you want to do more than help with coding, click below: [![Terminal](https://badgen.net/badge/IDonate/.AddCharityToAma()/red?icon=terminal)](https://www.paypal.com/BR/fundraiser/charity/3955029) +## Milestone (vNext) +Track or suggest improvements for future versions. +![GitHub milestone details](https://img.shields.io/github/milestones/progress/raphaelmoreira/lensophy/2) +![GitHub issues](https://img.shields.io/github/issues/raphaelmoreira/lensophy) +![GitHub watchers](https://img.shields.io/github/watchers/raphaelmoreira/lensophy) +![GitHub repo size](https://img.shields.io/github/repo-size/raphaelmoreira/lensophy) +![GitHub tag checks state](https://img.shields.io/github/checks-status/raphaelmoreira/lensophy/v1.0.0) [![Lensophy](https://dev.azure.com/raphaelmoreira/758a305a-a7fa-4b96-95aa-962c2cf2248c/_apis/git/repositories/27fc1054-4851-4e6d-af8a-a463841dc8c1/items?path=/footer.png&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream)](https://raphaelmoreira.github.io/lensophy/)