Improvement :

- styling added.
fiko · Feb 5, 2022 · a98ba53 · a98ba53
1 parent 824c04b
commit a98ba53
Show file tree

Hide file tree

Showing 138 changed files with 42,408 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,49 @@
 # magento2-uifrontend
 
-At the moment, I'm trying to develop UI component so developers can use UI component on frontend side whereas it's not possible by default.
+It's implementing the ui grid component from adminhtml to frontend side.
+
+![Image 1](https://i.imgur.com/5HZk9CQ.png)
+
+## How to install?
+
+#### Via Composer
+
+If you try to install via composer, just require your project to the module by running this command :
+
+```
+composer require fiko/magento2-uifrontend
+```
+
+#### Manually
+
+1. Download this repo
+2. Create a Directory `app/code/Fiko/UiFrontEnd`
+3. Copy downloaded repo to this directory
+
+Once you download it (both composer or manually), just run this commands to apply this module to your project :
+
+```
+php bin/magento setup:upgrade
+php bin/magento setup:di:compile
+php bin/magento setup:static-content:deploy
+```
+
+## How to use?
+
+Simply just add extra css to the layout/grid.
+
+```
+<head>
+    <css src="Fiko_UiFrontEnd::css/grid.css" />
+</head>
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/) &copy; 2022