Skip to content

Commit 3c73cb6

Browse files
authored
Update README.md
1 parent 5f8258b commit 3c73cb6

File tree

1 file changed

+46
-4
lines changed

1 file changed

+46
-4
lines changed

README.md

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,49 @@
11
<div align="center">
2-
<img width="180px" src="src/logo.svg">
3-
<h1>Codeigniter viteJs</h1>
2+
<img width="160px" src="src/logo.svg">
3+
<h1>Codeigniter + viteJs</h1>
44
<p>Vitejs Integration For Codeigniter4</p>
5-
<hr />
6-
<h2>🚧 W.I.P 🚧</h2>
75
</div>
6+
7+
## Features:
8+
- ⏱️ Almost zero configuration
9+
- 🧩 Easy to install and remove
10+
- 🔨 Easy to customize
11+
- ✌️ Support most used frameworks: `react`, `vue`, and `svlete`
12+
- 🔥 Enjoy hot module replacement (HMR)
13+
14+
## Installation:
15+
16+
> As codeigniter4, make sure php ^7.4 is installed
17+
18+
```
19+
composer require mihatori/codeignitervite
20+
```
21+
22+
then from your project root, run:
23+
24+
```
25+
php spark vite:init --framework <framework>
26+
```
27+
28+
replace `<framework>` with `vue`, `react`, `svelte`, or `none`
29+
30+
or you can just run:
31+
32+
```
33+
php spark vite:init
34+
```
35+
36+
our body spark will handle the rest for you 🙃
37+
38+
**That's it**
39+
you can now run `npm install`, `npm run dev` and enjoy your time
40+
41+
## What next?
42+
More informations will be availiable as soon as possible ❤️.
43+
44+
### additional:
45+
You will find som new vaiables in your .env file, you can change them as you like.
46+
47+
## License
48+
49+
MIT License &copy; 2022 [Mihatori Kei](https://github.com/firtadokei)

0 commit comments

Comments
 (0)