Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ujjalzaman authored Nov 19, 2021
1 parent a6e8ab9 commit 7ad6ed5
Showing 1 changed file with 25 additions and 38 deletions.
63 changes: 25 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Project Link: [https://github.com/Ujjalzaman/Easy-Consulting-react](https://gith


<!-- ABOUT THE PROJECT -->
## About The Project
## Features

[![Product Name Screen Shot][product-screenshot]](https://example.com)

Expand All @@ -129,18 +129,38 @@ Here's why:
* Your time should be focused on creating something amazing. A project that solves a problem and helps others
* You shouldn't be doing the same tasks over and over like creating a README from scratch
* You should implement DRY principles to the rest of your life :smile:
* mymui provides two tools for styling and building Material-UI components quickly and easily
* Theme Styler allows the customization of a Material-UI theme with a dynamic visual interface
* Adjust color, button styling, typography, and alerts with palettes, switches, sliders + more
* Download a custom theme and apply it to your project using Material-UI's ThemeProvider
* Save and share your theme with the mymui community
* Discover user created themes via the explore page
* Star and bookmark your favorite themes
* Grid Builder follows the 12 column grid system and visualizes how Material-UI structures grid layouts and positioning
* Drag, drop, and resize grid containers, and observe the code adjust in real-time

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

Use the `BLANK_README.md` to get started.

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- GETTING STARTED -->
## Getting Started
<!-- Project Challenges -->
## Project Challenges

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
[![Product Name Screen Shot][product-screenshot]](https://example.com)

There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:
* Grid Builder follows the 12 column grid system and visualizes how Material-UI structures grid layouts and positioning
* Drag, drop, and resize grid containers, and observe the code adjust in real-time
* Managing the number of props + state of the custom theme object throughout our application — more than four dozen parameters!
* Assigning the logic of change handlers to different selection tools within the design page
* Learning the functionality of a NoSQL database (Firestore), and the referencing of deeply nested objects
* Firebase data flow, integration of Firebase + Google Cloud functions, and how authentication interacts with database
* Implementing drag and drop functionality with vanilla Javascript rather than a library, and gaining an understanding of how implementation works under the hood
* Building social aspects ie. starring and bookmarking themes — capturing and storing interactions between users

### Prerequisites

Expand All @@ -151,21 +171,6 @@ This is an example of how to list things you need to use the software and how to
```


<!-- USAGE EXAMPLES -->
## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- CONTACT -->
## Contact
Expand All @@ -178,24 +183,6 @@ Project Link: [https://github.com/your_username/repo_name](https://github.com/yo



<!-- ACKNOWLEDGMENTS -->
## Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
* [Malven's Grid Cheatsheet](https://grid.malven.co/)
* [Img Shields](https://shields.io)
* [GitHub Pages](https://pages.github.com)
* [Font Awesome](https://fontawesome.com)
* [React Icons](https://react-icons.github.io/react-icons/search)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
Expand Down

0 comments on commit 7ad6ed5

Please sign in to comment.