Skip to content

Commit 3341ee0

Browse files
Added changelog and docs skeleton
1 parent 09f8dff commit 3341ee0

8 files changed

+53
-5
lines changed

CHANGELOG.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CHANGELOG
2+
3+
This changelog references the relevant changes done between versions.
4+
5+
To get the diff for a specific change, go to https://github.com/LIN3S/PatternLibraryBuilder/commit/XXX where XXX is the change hash
6+
To get the diff between two versions, go to https://github.com/LIN3S/PatternLibraryBuilder/compare/v0.1.0...v0.2.0
7+
8+
* 0.2.0
9+
* [BC break] Renderers. Changed configuration yml structure to adapt to new renderer (#12).
10+
To upgrade check renderers documentation.
11+
12+
* 0.1.0
13+
* Initial release

README.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,39 @@
11
# PatternLibraryBuilder
22
> Library that provides an elegant and easy way to develop a pattern library for your front-end components
33
4-
## Requirements
5-
PHP >= 7.1</br>
4+
## Features
5+
6+
* YAML config driven pattern library builder
7+
* Opinated and extensible default template
8+
* Use already existing renderers to list colors, typography, iconography
9+
* Render twig templates in responsive viewports and with autogenerated twig "include" method and HTML output
10+
* Easily create your renderer to adapt it to your needs
11+
* Standalone PHP library with built-in Symfony integration
612

713
## Installation
14+
815
The easiest way to install this bundle is using [Composer][1]
916
```bash
1017
$ composer require lin3s/pattern-library-builder
1118
```
1219

1320
## Documentation
14-
All the documentation is stored in the `docs` folder.
1521

16-
[Show me the docs!](PatternLibraryBuilder/docs/index.md)
22+
* First use
23+
* [Installing and configuring](docs/first_use_installing_and_configuring.md)
24+
* [Your first page](docs/first_use_your_first_page.md)
25+
* Renderers
26+
* [Using renderers](docs/renderers_usage.md)
27+
* [Creating custom renderers](docs/renderers_create_custom.md)
28+
* Theme
29+
* [Customizing default theme](docs/theme_customize_default.md)
30+
* Symfony integration
31+
* [Configuration reference](docs/symfony_configuration_reference.md)
32+
33+
> All the documentation is stored in the `docs` folder.
1734
1835
## Tests
19-
This library is completely tested by **[PHPSpec][2], SpecBDD framework for PHP**.
36+
This library is tested by **[PHPSpec][2], SpecBDD framework for PHP**.
2037

2138
Run the following command to launch tests:
2239
```bash
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Installing and configuring
2+
3+
> TODO

docs/first_use_your_first_page.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Your first page
2+
3+
For this example we are showing

docs/renderers_create_custom.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Creating custom renderers
2+
3+
> TODO

docs/renderers_usage.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Using renderers
2+
3+
> TODO
+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Symfony Configuration reference
2+
3+
> TODO

docs/theme_customize_default.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Customizing default theme
2+
3+
> TODO

0 commit comments

Comments
 (0)