Update README.md

This commit is contained in:
ульба 2022-01-22 13:55:45 +05:00
parent a849e53b6c
commit f5436eed72
2 changed files with 49 additions and 0 deletions

49
readme.rst Normal file
View File

@ -0,0 +1,49 @@
.. role:: raw-html-m2r(raw)
:format: html
.. raw:: html
<div align="center">
<h1>MockupEngineer</h1>
<p>An simple library for creating beautiful screenshots.</p>
</div>
Example
-------
:raw-html-m2r:`<img align="center" width="350" src="https://raw.githubusercontent.com/ulbwazhine/MockupEngineer/main/MockupModule/templates/iphone12promax/example.png" alt="Apple iPhone 12 Pro Max">`
Usage
-----
In Python console:
.. code-block:: python
from MockupModule import MockupEngineer
mockup = MockupEngineer()
mockup.generate(template=mockup.templates[0],
screenshot_path='/path/to/screenshot',
color=mockup.templates[0].colors[0].color)
.. code-block::
>>> /path/to/mockup
As a standalone application:
.. code-block::
$ python -m MockupModule
Links
-----
* `Author <https://t.me/ulbwa>`_
* `GitHub <https://github.com/ulbwazhine/MockupEngineer>`_