Skip to content

Commit d802492

Browse files
committed
update README.md
1 parent 66b36ee commit d802492

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# DevNet Framework
2+
This dependency is the main repository of **DevNet Framework**, and it includes the following packages:
3+
- [devnet/core](https://github.com/DevNet-Framework/core) a runtime and base class library that is essential for all DevNet applications and packages.
4+
- [devnet/cli](https://github.com/DevNet-Framework/cli) a command-line interface tool, for creating console applications and managing DevNet projects.
5+
- [devnet/web](https://github.com/DevNet-Framework/web) a collection of web components that helps to create modern web applications and web APIs.
6+
- [devnet/entity](https://github.com/DevNet-Framework/entity) an object-relational mapping system that helps to manipulate databases in an object-oriented way.
7+
8+
## Requirements
9+
- [PHP](https://www.php.net/) version 7.4 to 8.1
10+
- [Composer](https://getcomposer.org/) version 2.0 or higher
11+
12+
## Installation
13+
You can install DevNet Framework in your project, by running the following command in the terminal:
14+
15+
```bash
16+
composer require devnet/framework
17+
```
18+
19+
You can install DevNet Framework globally in your system, by run the following command in the terminal:
20+
```
21+
composer global require devnet/framework
22+
```
23+
24+
>**Note:** In order to run DevNet CLI globally in linux os, you need to add composer **bin** into the system environment variables.
25+
>`echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc`
26+
27+
## Documentation
28+
Full documentation on how to use **DevNet Framework** is available at [devnet-framework.github.io](https://devnet-framework.github.io)
29+
30+
## License
31+
This library is licensed under the MIT license. See [License File](https://github.com/DevNet-Framework/framework/blob/master/LICENSE) in the root folder for more information.

0 commit comments

Comments
 (0)