Skip to content

Commit d20acd3

Browse files
author
Christoph Erdmann
committed
updated composer.json, license and readme
1 parent 3c7d14c commit d20acd3

File tree

3 files changed

+76
-7
lines changed

3 files changed

+76
-7
lines changed

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2016, medienpol
1+
Copyright (c) 2016, macgyer
22
All rights reserved.
33

44
Redistribution and use in source and binary forms, with or without
@@ -11,7 +11,7 @@ modification, are permitted provided that the following conditions are met:
1111
this list of conditions and the following disclaimer in the documentation
1212
and/or other materials provided with the distribution.
1313

14-
* Neither the name of yii2-icon nor the names of its
14+
* Neither the name of yii2-materializecss nor the names of its
1515
contributors may be used to endorse or promote products derived from
1616
this software without specific prior written permission.
1717

README.md

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,72 @@
11
# Materialize for Yii2
22

3-
Work in progress ...
3+
This package integrates the Materialize CSS framework into [Yii2](http://www.yiiframework.com/).
4+
[Materialize](http://materializecss.com/) is a modern responsive front-end framework based on Material Design.
5+
6+
## Installation
7+
8+
The preferred way of installation is through Composer.
9+
If you don't have Composer you can get it here: https://getcomposer.org/
10+
11+
To install the package add the following to the ```required``` section of your composer.json:
12+
```
13+
"require": {
14+
"macgyer/yii2-materializecss": "@dev"
15+
},
16+
```
17+
18+
And make Composer aware of the corresponding Github repository in the ```repositories``` section of your composer.json:
19+
```
20+
"repositories" : [
21+
{
22+
"type": "vcs",
23+
"url": "https://github.com/macgyer/yii2-materializecss.git"
24+
}
25+
]
26+
```
27+
28+
## Usage
29+
30+
To load the Materialize CSS files integrate the MaterializeAsset into your app.
31+
Two ways to achieve this is to register the asset in the main layout:
32+
33+
```php
34+
// @app/views/layouts/main.php
35+
36+
\macgyer\yii2materializecss\assets\MaterializeAsset::register($this);
37+
// further code
38+
```
39+
40+
or as a dependency in your app wide AppAsset.php
41+
42+
```php
43+
// @app/assets/AppAsset.php
44+
45+
public $depends = [
46+
'macgyer\yii2materializecss\assets\MaterializeAsset',
47+
// more dependencies
48+
];
49+
```
50+
51+
## Widgets
52+
53+
The following widgets are currently available:
54+
55+
* Alert
56+
* Breadcrumbs
57+
* Button
58+
* Chip
59+
* Dropdown
60+
* Icon
61+
* Nav
62+
* NavBar
63+
64+
These widgets are planned for development:
65+
66+
* GridView with ActionColumn and DataColumn
67+
* ActiveForm and ActiveField
68+
* Collection
69+
* Pagination
70+
* Modal
71+
* Toast
72+
* Collapsible

composer.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "medienpol/yii2-materialize",
2+
"name": "macgyer/yii2-materializecss",
33
"minimum-stability": "stable",
4-
"description": "Materialize implementation for Yii2",
4+
"description": "Materialize CSS implementation for Yii2",
55
"keywords": "materialize, yii2, widgets, material design",
66
"type": "yii2-extension",
77
"authors": [
@@ -11,7 +11,7 @@
1111
"role": "Developer"
1212
}
1313
],
14-
"version": "1.0.0",
14+
"version": "0.9.0",
1515
"require": {
1616
"php": ">=5.4.0",
1717
"yiisoft/yii2": "~2.0",
@@ -20,7 +20,7 @@
2020
},
2121
"autoload": {
2222
"psr-4": {
23-
"medienpol\\yii2materialize\\": "src"
23+
"macgyer\\yii2materializecss\\": "src"
2424
}
2525
}
2626
}

0 commit comments

Comments
 (0)