wip

README.md

@@ -1,6 +1,48 @@
 # Lina PHP - lightweight and blazing fast static blog generator
 
-Lina is an opinionated flat-file CMS for who want a simple and fast blog. The template using `Blade` template engine, so you can use all Blade features.
+**Lina** is an opinionated flat-file CMS for who want a simple and fast blog. The template using Blade template engine, so you can use all Blade features.
+
+To help you get started, we have created a few example posts. You can find them in the `content/posts` directory.
+
+## Requirements
+- PHP 8.3
+
+## Getting started
+```bash
+lina new my-blog
+```
+
+### Create a blog
+```bash
+composer global require bangnokia/lina
+```
+
+### Folder structure
+```
+content/
+    posts/
+        2020-11-01-hello.md
+    index.md
+
+resources/
+    views/
+
+public/
+```
+
+There are some function that you can use to get content from your site.
+
+### Get all content in a directory
+```php
+foreach (cf()->index('post') as $post) {
+    echo $post->title;
+}
+```
+
+### Get a single content
+```php
+$post = cf()->get('posts/2020-11-01-hello.md');
+```
 
 - [x] Add `lina serve` command for development
 - [x] Add code highlighter support