Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ikkez authored Apr 26, 2018
1 parent e49cb85 commit bc09ff4
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# fatfree-core
Fat-Free Framework core library

### Usage:

First make sure to add a proper url rewrite configuration to your server, see https://fatfreeframework.com/3.6/routing-engine#DynamicWebSites

**without composer:**

```php
$f3 = require('lib/base.php');
```

**with composer:**

```
composer require bcosca/fatfree-core
```

```php
require("vendor/autoload.php");
$f3 = \Base::instance();
```

---
For the main repository (demo package), see https://github.com/bcosca/fatfree
For the test bench and unit tests, see https://github.com/bcosca/fatfree/tree/dev
For the user guide, see https://fatfreeframework.com/user-guide
For the documentation, see https://fatfreeframework.com/api-reference

0 comments on commit bc09ff4

Please sign in to comment.