Skip to content

Commit aa42931

Browse files
mychidarkomychidarko
committed
chore: update readme
1 parent fe50aef commit aa42931

File tree

1 file changed

+15
-125
lines changed

1 file changed

+15
-125
lines changed

‎README.md‎

Lines changed: 15 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!-- markdownlint-disable no-inline-html -->
22
<p align="center">
33
<br><br>
4-
<img src="https://leafphp.netlify.app/assets/img/leaf3-logo.png" height="100"/>
4+
<img src="https://leafphp.dev/logo-circle.png" height="100"/>
55
<br>
66
</p>
77

8-
<h1 align="center">Leaf Http v2</h1>
8+
<h1 align="center">Leaf Http</h1>
99

1010
<p align="center">
1111
<a href="https://packagist.org/packages/leafs/http"
@@ -27,7 +27,7 @@
2727
<br />
2828
<br />
2929

30-
Leaf's core http functionality packaged as a serve-yourself module. **Although seperated from Leaf core, it is still part of the default initial installation and doesn't need to be installed manually (unless you want a particular version).**
30+
Leaf's HTTP abstraction is a developer friendly way to interact with HTTP requests and responses. If you are using it within a Leaf app, there's no need to install anything as it comes pre-installed with Leaf. If you are using it outside of Leaf, you can install it via composer.
3131

3232
## Installation
3333

@@ -45,140 +45,30 @@ composer require leafs/http
4545

4646
## Basic Usage
4747

48-
The http module comes with a bunch of packages which help you manage the input and output of your app or API. This module comes with the most used Http related functionality like requests, responses, ...
48+
You can find the full documentation on how to use Leaf Http [here](https://leafphp.dev/docs/http/request).
4949

50-
The available classes in the Http module are:
51-
52-
- [`Leaf\Http\Request`](https://leafphp.dev/modules/http/request)
53-
- [`Leaf\Http\Response`](https://leafphp.dev/modules/http/response)
54-
- [`Leaf\Http\Headers`](https://leafphp.dev/modules/http/headers)
55-
- [`Leaf\Http\Cache`](https://leafphp.dev/modules/http/cache)
56-
- [`Leaf\Http\Status`](https://leafphp.dev/modules/http/status)
57-
58-
**The docs for Leaf Http v2 can be found at [https://leafphp.dev/modules/http/v/2/](https://leafphp.dev/modules/http/v/2/).**
59-
60-
## Request
61-
62-
This is a developer friendly interface which allows you to interact with data coming into your application. [Read the docs](https://leafphp.dev/modules/http/request)
63-
64-
## Response
65-
66-
This interface allows you to output data from your application in different forms. [Read the docs](https://leafphp.dev/modules/http/response)
67-
68-
## Headers
69-
70-
This interface allows you to manage headers in your application. [Read the docs](https://leafphp.dev/modules/http/headers)
71-
72-
## Cache
73-
74-
This interface allows you to manage http cache in your app. [Read the docs](https://leafphp.dev/modules/http/cache)
75-
76-
## Status
77-
78-
This interface allows you to manage http status codes in your app. [Read the docs](https://leafphp.dev/modules/http/status)
79-
80-
**There are also some add on classes which can be installed on demand.**
81-
82-
## Session (module)
83-
84-
This module allows you to manage session in your application. [Read the docs](/modules/session/)
85-
86-
## Cookies (module)
87-
88-
This module allows you to manage cookies in your application. [Read the docs](/modules/cookies)
89-
90-
## 💬 Stay In Touch
50+
## Stay In Touch
9151

9252
- [Twitter](https://twitter.com/leafphp)
9353
- [Join the forum](https://github.com/leafsphp/leaf/discussions/37)
9454
- [Chat on discord](https://discord.com/invite/Pkrm9NJPE3)
9555

96-
## 📓 Learning Leaf 3
56+
## Learning Leaf PHP
9757

9858
- Leaf has a very easy to understand [documentation](https://leafphp.dev) which contains information on all operations in Leaf.
9959
- You can also check out our [youtube channel](https://www.youtube.com/channel/UCllE-GsYy10RkxBUK0HIffw) which has video tutorials on different topics
100-
- We are also working on codelabs which will bring hands-on tutorials you can follow and contribute to.
60+
- You can also learn from [codelabs](https://leafphp.dev/codelabs/) and contribute as well.
10161

102-
## 😇 Contributing
62+
## Contributing
10363

10464
We are glad to have you. All contributions are welcome! To get started, familiarize yourself with our [contribution guide](https://leafphp.dev/community/contributing.html) and you'll be ready to make your first pull request 🚀.
10565

10666
To report a security vulnerability, you can reach out to [@mychidarko](https://twitter.com/mychidarko) or [@leafphp](https://twitter.com/leafphp) on twitter. We will coordinate the fix and eventually commit the solution in this project.
10767

108-
### Code contributors
109-
110-
<table>
111-
<tr>
112-
<td align="center">
113-
<a href="https://github.com/mychidarko">
114-
<img src="https://avatars.githubusercontent.com/u/26604242?v=4" width="120px" alt=""/>
115-
<br />
116-
<sub>
117-
<b>Michael Darko</b>
118-
</sub>
119-
</a>
120-
</td>
121-
<td align="center">
122-
<a href="https://github.com/Dreamer0x01">
123-
<img src="https://avatars.githubusercontent.com/u/12978365?v=4" width="120px" alt=""/>
124-
<br />
125-
<sub>
126-
<b>Dreamer0x01</b>
127-
</sub>
128-
</a>
129-
</td>
130-
</tr>
131-
</table>
132-
133-
## 🤩 Sponsoring Leaf
134-
135-
Your cash contributions go a long way to help us make Leaf even better for you. You can sponsor Leaf and any of our packages on [open collective](https://opencollective.com/leaf) or check the [contribution page](https://leafphp.dev/support/) for a list of ways to contribute.
136-
137-
And to all our existing cash/code contributors, we love you all ❤️
138-
139-
### Cash contributors
140-
141-
<table>
142-
<tr>
143-
<td align="center">
144-
<a href="https://opencollective.com/aaron-smith3">
145-
<img src="https://images.opencollective.com/aaron-smith3/08ee620/avatar/256.png" width="120px" alt=""/>
146-
<br />
147-
<sub><b>Aaron Smith</b></sub>
148-
</a>
149-
</td>
150-
<td align="center">
151-
<a href="https://opencollective.com/peter-bogner">
152-
<img src="https://images.opencollective.com/peter-bogner/avatar/256.png" width="120px" alt=""/>
153-
<br />
154-
<sub><b>Peter Bogner</b></sub>
155-
</a>
156-
</td>
157-
<td align="center">
158-
<a href="#">
159-
<img src="https://images.opencollective.com/guest-32634fda/avatar.png" width="120px" alt=""/>
160-
<br />
161-
<sub><b>Vano</b></sub>
162-
</a>
163-
</td>
164-
<td align="center">
165-
<a href="#">
166-
<img
167-
src="https://images.opencollective.com/guest-c72a498e/avatar.png"
168-
width="120px"
169-
alt=""
170-
/>
171-
<br />
172-
<sub><b>Casprine</b></sub>
173-
</a>
174-
</td>
175-
</tr>
176-
</table>
177-
178-
## 🤯 Links/Projects
179-
180-
- [Aloe CLI](https://leafphp.dev/aloe-cli/)
181-
- [Leaf Docs](https://leafphp.dev)
182-
- [Leaf MVC](https://mvc.leafphp.dev)
183-
- [Leaf API](https://api.leafphp.dev)
184-
- [Leaf CLI](https://cli.leafphp.dev)
68+
## Sponsoring Leaf
69+
70+
We are committed to keeping Leaf open-source and free, but maintaining and developing new features now requires significant time and resources. As the project has grown, so have the costs, which have been mostly covered by the team. To sustain and grow Leaf, we need your help to support full-time maintainers.
71+
72+
You can sponsor Leaf and any of our packages on [open collective](https://opencollective.com/leaf) or check the [contribution page](https://leafphp.dev/support/) for a list of ways to contribute.
73+
74+
And to all our [existing cash/code contributors](https://leafphp.dev#sponsors), we love you all ❤️

0 commit comments

Comments
 (0)