Merge pull request #115 from utopia-php/docs-improve-readme

Docs: Improve readme

Author: eldadfux

.github/ISSUE_TEMPLATE/bug.yaml

@@ -34,7 +34,7 @@ body:
   - type: dropdown
     id: utopia-version
     attributes:
-      label: "🎲 Utopia Framework version"
+      label: "🎲 Utopia HTTP version"
       description: "What version of Utopia are you running?"
       options:
         - Version 0.18.x

.github/workflows/test.yml

@@ -15,6 +15,9 @@ jobs:
       with:
         php-version: '8.1'
 
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
     - name: Setup Docker
       run: docker-compose up -d --build
 
@@ -23,6 +26,6 @@ jobs:
 
     - name: Run FPM Tests
       run: docker compose exec fpm vendor/bin/phpunit --configuration phpunit.xml
-    
+
     - name: Run Swoole Tests
       run: docker compose exec swoole vendor/bin/phpunit --configuration phpunit.xml

CONTRIBUTING.md

@@ -1,16 +1,16 @@
 # Contributing
 
-We would ❤️ for you to contribute to Framework and help make it better! We want contributing to Framework to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.
+We would ❤️ for you to contribute to Utopia HTTP and help make it better! We want contributing to this library to be fun, enjoyable, and educational for anyone and everyone. All contributions are welcome, including issues, new docs as well as updates and tweaks, blog posts, workshops, and more.
 
 ## How to Start?
 
 If you are worried or don’t know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can reach out with questions to [Eldad Fux (@eldadfux)](https://twitter.com/eldadfux) or [@appwrite_io](https://twitter.com/appwrite_io) on Twitter, and anyone from the [Appwrite team on Discord](https://discord.gg/GSeTUeA). You can also submit an issue, and a maintainer can guide you!
 
-You can get an in-depth understanding of the Utopia-PHP framework in our [Getting Started](docs/Getting-Starting-Guide.md) guide.
+You can get an in-depth understanding of Utopia HTTP in our [Getting Started](docs/Getting-Starting-Guide.md) guide.
 
 ## Code of Conduct
 
-Help us keep framework open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md).
+Help us keep Utopia HTTP open and inclusive. Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md).
 
 ## Submit a Pull Request 🚀
 
@@ -72,38 +72,38 @@ $ git push origin [name_of_your_new_branch]
 
 ## Introducing New Features
 
-We would 💖 you to contribute to Framework, but we would also like to make sure Framework is as great as possible and loyal to its vision and mission statement 🙏.
+We would 💖 you to contribute to Utopia HTTP, but we would also like to make sure this library is as great as possible and loyal to its vision and mission statement 🙏.
 
 For us to find the right balance, please open an issue explaining your ideas before introducing a new pull request.
 
-This will allow the Framework community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.
+This will allow the community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.
 
-This is also important for the Framework lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc).
+This is also important for the repository owners to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/appwrite/rfc).
 
 ## Other Ways to Help
 
-Pull requests are great, but there are many other areas where you can help Framework
+Pull requests are great, but there are many other areas where you can help:
 
 ### Blogging & Speaking
 
-Blogging, speaking about, or creating tutorials about one of Framework's many features is great way to contribute and help our project grow.
+Creating blog posts, giving talks, or developing tutorials about one of this library's many features are excellent ways to contribute and help our project grow.
 
 ### Presenting at Meetups
 
-Presenting at meetups and conferences about your Framework projects. Your unique challenges and successes in building things with Framework can provide great speaking material. We’d love to review your talk abstract/CFP, so get in touch with us if you’d like some help!
+Presenting at meetups and conferences about your Utopia projects. Your unique challenges and successes in building things with this library can provide great speaking material. We’d love to review your conference talk abstract, so get in touch with us if you’d like some help!
 
 ### Sending Feedbacks & Reporting Bugs
 
-Sending feedback is a great way for us to understand your different use cases of Framework better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA).
+Sending feedback is a great way for us to understand your different use cases of this library better. If you had any issues, bugs, or want to share about your experience, feel free to do so on our GitHub issues page or at our [Discord channel](https://discord.gg/GSeTUeA).
 
 ### Submitting New Ideas
 
-If you think Framework could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature.
+If you think this library could use a new feature, please open an issue on our GitHub repository, stating as much information as you can think about your new idea and it's implications. We would also use this issue to gather more information, get more feedback from the community, and have a proper discussion about the new feature.
 
 ### Improving Documentation
 
 Submitting documentation updates, enhancements, designs, or bug fixes. Spelling or grammar fixes will be very much appreciated.
 
 ### Helping Someone
 
-Searching for Framework on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to Framework's repo!
+Searching for Utopia HTTP on Discord, GitHub, or StackOverflow and helping someone else who needs help. You can also help by teaching others how to contribute to this repo!

README.md

@@ -2,19 +2,20 @@
     <img height="45" src="docs/logo.png" alt="Logo">
 </p>
 
-[![Build Status](https://travis-ci.org/utopia-php/framework.svg?branch=master)](https://travis-ci.org/utopia-php/framework)
-![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/framework.svg)
+[![Build Status](https://travis-ci.org/utopia-php/http.svg?branch=master)](https://travis-ci.org/utopia-php/http)
+![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/http.svg)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://discord.gg/GSeTUeA)
 
-Utopia Framework is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io).
+Utopia HTTP is a PHP MVC based framework with minimal must-have features for professional, simple, advanced and secure web development. This library is maintained by the [Appwrite team](https://appwrite.io).
 
-Utopia Framework is dependency-free. Any extra features, such as authentication or caching, will be available as standalone models in order to keep the framework core clean, light, and easy to learn.
+Utopia HTTP is dependency-free. Any extra features, such as authentication or caching are available as standalone models in order to keep the framework core clean, light, and easy to learn.
 
 ## Getting Started
 
-Install using composer:
+Install using Composer:
+
 ```bash
-composer require utopia-php/framework
+composer require utopia-php/http
 ```
 
 Init your first application in `src/server.php`:
@@ -49,7 +50,7 @@ $http->start();
 Run HTTP server:
 
 ```bash
-php -S localhost:8000 src/server2.php 
+php -S localhost:8000 src/server.php 
 ```
 
 Send HTTP request:
@@ -60,7 +61,7 @@ curl http://localhost:8000/hello-world
 
 ### Server Adapters
 
-The library supports server adapters to be able to run on any PHP setup. For instance, you could use the FPM server or the Swoole server.
+The library supports server adapters to be able to run on any PHP setup. You could use the FPM or Swoole server.
 
 #### Use PHP FPM server
 
@@ -203,7 +204,7 @@ Http::init()
     });
 ```
 
-Groups are designed to be actions that run during the lifecycle of requests to endpoints that have some logic in common. Groups allow you to prevent code duplication and are designed to be defined anywhere in your source code to allow flexibility. 
+Groups are designed to be actions that run during the lifecycle of requests to endpoints that have some logic in common. Groups allow you to prevent code duplication and are designed to be defined anywhere in your source code to allow flexibility.
 
 ### Resources
 
@@ -243,17 +244,17 @@ In advanced scenarios, resources can also be injected into other resources or en
 
 Resources are designed to prepare dependencies or context for the request. Resources are not meant to do functional logic or return callbacks. For such a use case, you should use hooks.
 
-To learn more about Framework architecture and features, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md).
+To learn more about architecture and features for this library, check out more in-depth [Getting started guide](/docs/Getting-Starting-Guide.md).
 
 ## System Requirements
 
-Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
+Utopia HTTP requires PHP 8.1 or later. We recommend using the latest PHP version whenever possible.
 
 ## More from Utopia
 
-Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia framework.
+Our ecosystem supports other thin PHP projects aiming to extend the core PHP Utopia HTTP.
 
-Each project is focused on solving a single, very simple problem and you can use composer to include any of them in your next project. 
+Each project is focused on solving a single, very simple problem and you can use composer to include any of them in your next project.
 
 You can find all libraries in [GitHub Utopia organization](https://github.com/utopia-php).
 
@@ -263,7 +264,7 @@ All code contributions - including those of people having commit access - must g
 
 Fork the project, create a feature branch, and send us a pull request.
 
-You can refer to the [Contributing Guide](https://github.com/utopia-php/framework/blob/master/CONTRIBUTING.md) for more info.
+You can refer to the [Contributing Guide](https://github.com/utopia-php/http/blob/master/CONTRIBUTING.md) for more info.
 
 For security issues, please email security@appwrite.io instead of posting a public issue in GitHub.
 

composer.json

@@ -1,10 +1,11 @@
 {
-    "name": "utopia-php/framework",
-    "description": "A simple, light and advanced PHP framework",
+    "name": "utopia-php/http",
+    "description": "A simple, light and advanced PHP HTTP framework",
     "type": "library",
     "keywords": [
         "php",
         "framework",
+        "http",
         "upf"
     ],
     "license": "MIT",