Skip to content

Commit 964ebd8

Browse files
committed
📝 modify README.md
Signed-off-by: otengkwame <[email protected]>
1 parent fed2127 commit 964ebd8

File tree

2 files changed

+34
-28
lines changed

2 files changed

+34
-28
lines changed

README.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
# Sylynder Engine
22

3-
The engine folder for Webby Framework Core extended functionalites enabled for CodeIgniter3 framework
3+
<p align="center">
4+
<img src="webby-readme.png" width="600" alt="Webby">
5+
</p>
6+
7+
The engine folder for Webby Framework Core extended functionalites enabled for CodeIgniter 3 framework
48

59
## Folder Structure
610

711
```
812
vendor/
913
└── sylynder/
1014
└── engine/
15+
└── CodeIgniter/
16+
└── Framework/
17+
├── core/
18+
├── database/
19+
├── fonts/
20+
├── helpers/
21+
├── language/
22+
└── libraries/
1123
└── Core/
1224
├── config/
1325
├── controllers/
@@ -22,18 +34,15 @@ vendor/
2234
2335
```
2436

25-
26-
<p align="center">
27-
<img src="webby-readme.png" width="600" alt="Webby">
28-
</p>
29-
30-
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs) ![Lines of code](https://img.shields.io/tokei/lines/github/sylynder/engine) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/sylynder/webby) ![Packagist Version](https://img.shields.io/packagist/v/sylynder/engine) ![Packagist Downloads (custom server)](https://img.shields.io/packagist/dt/sylynder/engine)
37+
![Lines of code](https://img.shields.io/tokei/lines/github/sylynder/engine) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/sylynder/webby) ![Packagist Version](https://img.shields.io/packagist/v/sylynder/engine) ![Packagist Downloads (custom server)](https://img.shields.io/packagist/dt/sylynder/engine)
3138

3239
## About Webby
3340

3441
**Webby** aims to be a "lego-like" PHP framework that allows you to build APIs, Console/Cli and Web Applications in a modular architecture, that can also integrate other features from existing PHP frameworks or other PHP packages with ease.
3542

36-
Build Awesome PHP applications with a "Sweet Application Architecture". It is an extension of the CodeIgniter3 framework for easy web application development with an easy developer experience (DX) for beginners.
43+
It is an extension of the CodeIgniter 3 framework for easy web application development with an easy developer experience (DX) for beginners.
44+
45+
Build Awesome PHP applications with a "Simple(Sweet) Application Architecture".
3746

3847
## Features
3948

@@ -47,11 +56,12 @@ Build Awesome PHP applications with a "Sweet Application Architecture". It is an
4756
- Use "Actions" instead of "Services" for CRUD functionalities or business logic
4857
- Use "Forms Or Rules" to validate input requests
4958
- A near "Service discovery" feature included
59+
- Use any database abstraction or library you want as a model
5060

5161
## Authors
5262

5363
- [@otengkwame](https://www.github.com/otengkwame)
54-
- [All contributors][link-contributors]
64+
- [All Contributors][link-contributors]
5565

5666
## Installation
5767

@@ -74,9 +84,12 @@ The documentation is currently been updated constantly. It will take time to cov
7484

7585
Currently we have planned to use the blogs section to guide developers through their journey in learning the framework.
7686

77-
If you have been developing with CodeIgniter3 already and you are familiar with the HMVC approach you can still use the same knowlegde to get going.
87+
If you have been developing with CodeIgniter 3 already and you are familiar with the HMVC approach you can still use the same knowlegde to get going.
88+
89+
For developers who are very familiar with the CodeIgniter 3 framework can still refer to the documentation here: [CI3 Docs](https://www.codeigniter.com/userguide3/index.html)
7890

79-
For developers who are very familiar with the CodeIgniter3 framework can still refer to the documentation here: [CI3 Docs](https://www.codeigniter.com/userguide3/index.html)
91+
The concept of CodeIgniter 4 has not been so clear and rewriting CodeIgniter 3 has set the framework back in so many ways, this is a way to show that Codeigniter could have been improved gradually without the approach the Core Team
92+
used.
8093

8194

8295
## Server Requirements
@@ -87,20 +100,22 @@ PHP 8.1 was released in November 2021 and so most of it's functionalities were n
87100

88101
~~If you want to discover bugs and contribute, then you are welcome to use the PHP 8.1 version.~~
89102

90-
Currently it supports 8.1 but no issues have come up yet. We will be looking forward to that as 8.2 is to be released later.
103+
Currently it supports 8.1 but no issues have come up yet. All issues can be discussed and it will be addressed. PHP 8.2 is here since December 2022. We will be looking forward to related issues too to resolve. Currently some issues have already been fixed.
91104

92105

93106
## Quick FAQs
94107

95108
#### Why did you decide to create Webby
96109
---
97-
* Webby was created with PHP beginners in mind, to simplify how web applications can be built without complex concepts and functionalities
98-
* Looking at how other frameworks makes it difficult for beginners to start, we are making the approach different.
99-
* Also CodeIgniter was not been updated for sometime and new PHP versions were not working until they updated to the recent version (3.1.13).
110+
* Webby was created with PHP beginners in mind, to simplify how web applications can be built (with PHP) without complex concepts and functionalities
111+
* Looking at how other (PHP) frameworks makes it difficult for beginners to start, we are making the approach different.
112+
* Also CodeIgniter 3 was not been updated for sometime and new PHP versions were not working until they updated to the recent version (3.1.13).
113+
* I used it as an opportunity to learn and understand more about Software Architecture and creating Software Paradigms.
100114

101115
#### Is it anything different from CodeIgniter 3 or 4?
102116
---
103-
It uses the Core of the CodeIgniter3 framework and borrows some new features added from CodeIgniter 4. It is designed to move developers who are familiar with CI3 to easily move to CI4 with a little similar syntax or concept.
117+
It uses the Core of the CodeIgniter 3 framework and borrows some new features added from CodeIgniter 4. It is designed to move developers who are familiar with CI3 to easily adapt to CI4 with a little similar syntax or concept.
118+
104119

105120
## Important Links
106121

@@ -109,7 +124,7 @@ The links below will guide you to know more about how Webby Works
109124
* [Installation Guide](https://webby.sylynder.com/docs/installation/)
110125
* [Getting Started](https://webby.sylynder.com/docs/getting-started/)
111126
* [Contribution Guide](https://webby.sylynder.com/docs/contribution-guide/)
112-
* [Learn Webby](https://webby.sylynder.com/blogs/)
127+
* [Learn Webby](https://blog.webby.sylynder.com)
113128
* [Community](https://github.com/sylynder/webby/discussions)
114129

115130
## What's Next
@@ -119,23 +134,14 @@ There are lots of future plans for Webby
119134
* [x] Improve and simplify CI3's database migrations
120135
* [x] Enable module based packages to use composer packages
121136
* [x] Enable easy engine folder upgrade (Currently folder will have to be replaced when an update is available) (Done on 30th October 2022 18:22 PM)
137+
* [x] Move sylynder/codeigniter repo to sylynder/engine repo (Done on 31st December 2022 15:08 PM)
122138
* [ ] Create a compatible HTTP and Routing feature (may be PSR-7 compatible) that enables general integration with other frameworks
123139
* [ ] Improve and optimize speed
124140
* [ ] Improve on cli or console feature
125141
* [ ] Integrate asynchronous features (may be fibers) [as a package]
126142
* [ ] And many more to add (and many more to learn)
127143
* [ ] Write version two (v2) without a major class api change so as to reduce future upgrade headache. Unlike other major PHP Frameworks
128144

129-
130-
131-
## Used By
132-
133-
This project is used by the following companies:
134-
135-
- Seguah Dreams
136-
- Glomot Company
137-
- Wigal Vision
138-
139145
## Credits
140146

141147
- Rougin (https://github.com/rougin/spark-plug)
@@ -146,7 +152,7 @@ This project is used by the following companies:
146152
- GustMartins (https://github.com/GustMartins/Slice-Library)
147153
- CodeIgniter 3 (https://github.com/bcit-ci/CodeIgniter)
148154
- CodeIgniter 4 (https://github.com/codeigniter4/CodeIgniter4)
149-
- [All contributors][link-contributors]
155+
- [All Contributors][link-contributors]
150156

151157

152158
## License

webby-readme.png

43.2 KB
Loading

0 commit comments

Comments
 (0)