diff --git a/MockupModule/__init__.py b/MockupModule/__init__.py
index eb3ac62..2d83363 100644
--- a/MockupModule/__init__.py
+++ b/MockupModule/__init__.py
@@ -24,6 +24,32 @@ class MockupEngineer:
import_module(name='MockupModule.templates.' + template,
package='MockupModule.templates.' + template + '.Device'), 'Device')())
+ def __create_mockups_list__(self) -> str:
+ output = list()
+ available_templates = self.get_templates()
+ specified_keys = {"pc": 'Computers',
+ 'wear': 'Wearable devices'}
+
+ for key, item in available_templates.items():
+ output.append(
+ '### {}'.format('{}s'.format(key.title()) if key not in specified_keys.keys() else specified_keys[key]))
+
+ for template in item:
+ output.append(
+ '* [{manufacturer} {name}](https://raw.githubusercontent.com/'
+ 'ulbwazhine/MockupEngineer/main/MockupModule/'
+ 'templates/{path}/example.png) [{resolution}] ({year})'.format(
+ manufacturer=template.manufacturer, name=template.name,
+ path=template.__template_path__, resolution=template.resolution,
+ year=template.year))
+
+ for color in sorted(template.colors, key=lambda a: a.color):
+ output.append(' * {}'.format(color.color))
+
+ output.append('')
+
+ return '\n'.join(output)
+
def __create_examples__(self, example_path: str) -> None:
for template in self.templates:
if os.path.isfile(template.example_path):
diff --git a/readme.md b/readme.md
index b7da789..12aac65 100644
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,15 @@
MockupEngineer
+
An simple library for creating beautiful screenshots.
## Example
-
-
+
+
+
Apple iPhone 12 Pro Max Mockup
+
## Install
```
@@ -35,6 +38,124 @@ As a standalone application:
$ python -m MockupModule
```
+## List of supported mockups
+
+Full list of all currently supported mockups
+
+### Phones
+* [Samsung Galaxy S20](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/galaxys20/example.png) [1440 x 3200] (2020)
+ * Cloud Blue
+ * Cosmic Grey
+ * Pink
+
+* [Samsung Galaxy S20 Ultra](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/galaxys20/example.png) [1440 x 3200] (2020)
+ * Cosmic Black
+ * Cosmic Grey
+
+* [Apple iPhone 12](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/iphone12/example.png) [1170 x 2532] (2020)
+ * Black
+ * Blue
+ * Green
+ * PRODUCT RED
+ * White
+
+* [Apple iPhone 12 Mini](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/iphone12mini/example.png) [1080 x 2340] (2020)
+ * Black
+ * Blue
+ * Green
+ * PRODUCT RED
+ * White
+
+* [Apple iPhone 12 Pro](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/iphone12pro/example.png) [1170 x 2532] (2020)
+ * Gold
+ * Graphite
+ * Pacific Blue
+ * Silver
+
+* [Apple iPhone 12 Pro Max](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/iphone12promax/example.png) [1284 x 2778] (2020)
+ * Gold
+ * Graphite
+ * Pacific Blue
+ * Silver
+
+* [Apple iPhone SE](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/iphonese2020/example.png) [750 x 1334] (2020)
+ * Black
+ * PRODUCT RED
+ * White
+
+* [Apple iPhone Xr](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/iphonexr/example.png) [828 x 1792] (2018)
+ * Blue
+ * Coral
+ * PRODUCT RED
+ * Silver
+ * Space Gray
+ * Yellow
+
+* [Google Pixel](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/pixel/example.png) [1080 x 1920] (2016)
+ * Quite Black
+ * Really Blue
+ * Very Silver
+
+* [Google Pixel 4](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/pixel4/example.png) [1080 x 2280] (2019)
+ * Clearly White
+ * Just Black
+ * Oh So Orange
+
+* [Google Pixel 4 XL](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/pixel4xl/example.png) [1440 x 3040] (2019)
+ * Clearly White
+ * Just Black
+ * Oh So Orange
+
+* [Google Pixel 5](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/pixel5/example.png) [1080 x 2340] (2020)
+ * Just Black
+ * Sorta Sage
+
+### Tablets
+* [Apple iPad 9](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/ipad9/example.png) [2160 x 1620] (2021)
+ * Gold
+ * Silver
+ * Space Gray
+
+* [Apple iPad Air 4](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/ipadair4/example.png) [2360 x 1640] (2020)
+ * Green
+ * Rose Gold
+ * Silver
+ * Sky Blue
+ * Space Gray
+
+* [Apple iPad Mini 5](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/ipadmini5/example.png) [2048 x 1536] (2021)
+ * Gold
+ * Silver
+ * Space Gray
+
+* [Apple iPad Pro 4 11"](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/ipadpro114/example.png) [2388 x 1668] (2020)
+ * Silver
+ * Space Gray
+
+* [Apple iPad Pro 4 12.9"](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/ipadpro134/example.png) [2732 x 2048] (2020)
+ * Silver
+ * Space Gray
+
+### Computers
+* [Apple MacBook 12"](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/macbook122016/example.png) [2304 x 1440] (2016)
+ * Gold
+ * Space Gray
+
+### Wearable devices
+* [Apple Watch Series 6 44mm](https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/watchseries644mm/example.png) [368 x 448] (2020)
+ * Aluminum Case - Blue
+ * Aluminum Case - Gold
+ * Aluminum Case - PRODUCT RED
+ * Aluminum Case - Silver
+ * Aluminum Case - Space Gray
+ * Stainless Steel Case - Gold
+ * Stainless Steel Case - Graphite
+ * Stainless Steel Case - Silver
+ * Titanium Case - Dark
+ * Titanium Case - Light
+
+You can help the project by adding support for new mockups by contributing on [GitHub](https://github.com/ulbwazhine/MockupEngineer).
+
## Links
* [Author](https://t.me/ulbwa)
* [GitHub](https://github.com/ulbwazhine/MockupEngineer)
diff --git a/setup.py b/setup.py
index 03325ce..25f63d9 100644
--- a/setup.py
+++ b/setup.py
@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
setup(
name='MockupEngineer',
- version='2022.23.01.10',
+ version='2022.23.01.11',
packages=find_packages(),
url='https://github.com/ulbwazhine/MockupEngineer',
license='MIT',