Skip to content

Commit 66ae305

Browse files
committed
update docs
1 parent d02a41e commit 66ae305

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
1-
# A simple content page management system with a flexible content block builder based on the Filament flexible content blocks package.
1+
# Filament Flexible Content Block Pages
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/statikbe/laravel-filament-flexible-content-block-pages.svg?style=flat-square)](https://packagist.org/packages/statikbe/laravel-filament-flexible-content-block-pages)
44
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/statikbe/laravel-filament-flexible-content-block-pages/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/statikbe/laravel-filament-flexible-content-block-pages/actions?query=workflow%3Arun-tests+branch%3Amain)
55
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/statikbe/laravel-filament-flexible-content-block-pages/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/statikbe/laravel-filament-flexible-content-block-pages/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/statikbe/laravel-filament-flexible-content-block-pages.svg?style=flat-square)](https://packagist.org/packages/statikbe/laravel-filament-flexible-content-block-pages)
77

8-
TODO This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
8+
A simple content page management system with a flexible content block builder based on the [Filament Flexible Content Blocks](https://github.com/statikbe/laravel-filament-flexible-content-blocks).
9+
10+
This package aims to provide a basic, batteries-included CMS for Filament by providing page creation in Filament and
11+
renders web pages that can be easily extended and styled.
12+
13+
Other features that will be provided:
14+
- Pages with hero, slugs, content blocks, publication options and SEO fields.
15+
- Website: routing, blade views, CSS themes included.
16+
- Extendable settings model and Filament resource to store CMS settings and images.
17+
- Redirect support for when slugs are renamed
18+
- Sitemap generation
19+
- A ready-to-use Filament panel with all CMS features implemented.
20+
- Extendable models, resources and database tables.
21+
- A simple asset manager (TODO)
22+
- Re-usable content blocks (TODO)
23+
- Contact form (TODO)
24+
25+
This package combines several existing packages and is therefore quite opinionated.
926

1027
## Installation
1128

0 commit comments

Comments
 (0)