Skip to content

Commit c75cdbe

Browse files
Add Readme
- and bugfix on css
1 parent e5bc710 commit c75cdbe

File tree

2 files changed

+57
-3
lines changed

2 files changed

+57
-3
lines changed

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,56 @@
1-
# MMM-SimpleLogo
2-
MagicMirror Modules Simple Logo
1+
# Module: MMM-SimpleLogo
2+
The `MMM-SimpleLogo` module is third party modules of the MagicMirror.
3+
This module simply displays logo.
4+
5+
## Using the module
6+
7+
To use this module, add it to the modules array in the `config/config.js` file:
8+
````javascript
9+
modules: [
10+
{
11+
module: 'MMM-SimpleLogo',
12+
position: 'top_left', // This can be any of the regions.
13+
config: {
14+
// The config property is optional.
15+
// See 'Configuration options' for more information.
16+
}
17+
}
18+
]
19+
````
20+
21+
## Configuration options
22+
23+
The following properties can be configured:
24+
25+
<table width="100%">
26+
<!-- why, markdown... -->
27+
<thead>
28+
<tr>
29+
<th>Option</th>
30+
<th width="100%">Description</th>
31+
</tr>
32+
<thead>
33+
<tbody>
34+
<tr>
35+
<td><code>fileUrl</code></td>
36+
<td>File url.<br>
37+
<br><b>Possible values:</b> Logo link form internet or path to your local files relative to MagicMirror directory
38+
<br><b>Default value:</b> <i>'modules/MMM-SimpleLogo/public/logo.png'</i>
39+
</td>
40+
</tr>
41+
<tr>
42+
<td><code>width</code></td>
43+
<td>Set width of your logo, height is auto.<br>
44+
<br><b>Possible values:</b> <code>'300px'</code> or <code>'50%'</code>
45+
<br><b>Default value:</b> <code>'200px'</code>
46+
</td>
47+
</tr>
48+
<tr>
49+
<td><code>position</code></td>
50+
<td>Horizontal position on current container<br>
51+
<br><b>Possible values:</b> <code>left</code>, <code>center</code>, or <code>right</code>
52+
<br><b>Default value:</b> <code>left</code>
53+
</td>
54+
</tr>
55+
</tbody>
56+
</table>

css/mmm-simplelogo.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
}
55

66
.simple-logo__container img {
7-
width: inherit;
7+
width: 100%;
88
height: inherit;
99
}
1010

0 commit comments

Comments
 (0)