Skip to content

Commit 69db5b4

Browse files
readme improvements
1 parent 4d099db commit 69db5b4

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A simple command line, markdown based blog add-on package for Laravel including support for tags and series of related posts.
44

5-
## Installing
5+
## Install and Quick Start
66

77
Include the package via composer:
88

@@ -30,7 +30,7 @@ php artisan vendor:publish --provider="SayWebSolutions\LetsBlog\Providers\LetsBl
3030

3131
Find the config file in `config/letsblog.php`.
3232

33-
Migrate the Let's Blog tables:
33+
### Migrate the Let's Blog Tables:
3434

3535
~~~
3636
php artisan migrate --path=/vendor/saywebsolutions/lets-blog/database/migrations
@@ -64,7 +64,6 @@ meta: LetsBlog package released for Laravel.
6464
keywords: letsblog, package, laravel, release
6565
published_at: 2018-03-17
6666
tags: LetsBlog, Laravel
67-
series: LetsBlog Package
6867
---
6968
7069
## Post Title
@@ -73,17 +72,17 @@ Post contents...
7372
7473
~~~
7574

76-
You can set any fields in the top section of the file. Any that DO NOT have a parser will just get tossed into a default `meta` field. Otherwise if a parser is found it will run. The parsers can manipulate a `data` object which ultimately get's passed into the `create` method for the `posts` table.
75+
You can set any fields in the top section (front matter) of the file. The [available parsers](https://github.com/saywebsolutions/lets-blog/tree/master/app/Parser/Field "LetsBlog Post Field Parsers") recieve the data defined in the front matter for each field, and can manipulate that data prior to being saved to the `posts` table.
7776

7877
Current parsers are:
7978

8079
* Title
8180
* Meta (description)
8281
* Body
8382
* PublishedAt
84-
* Permalink (`slug`)
83+
* Slug (if not defined will fallback to filename)
8584
* Tags
86-
* Series
85+
* Series (optional name of the series to which to post belongs)
8786

8887
## Migrations
8988

0 commit comments

Comments
 (0)