-
-
- project_description
+ {{project.description}}
- Explore the docs ยป
+
+ Explore the docs ยป
+
- View Demo
- ·
- Report Bug
- ·
- Request Feature
+
+ View Demo
+
+ ยท
+
+ Report Bug
+
+ ยท
+
+ Request Feature
+
| **{{contact.name}}** |
+| ๐ง | [{{contact.email}}](mailto:{{contact.email}}) |
+| ๐ | [@{{repository.github_username}}](https://github.com/{{repository.github_username}}) |
+{{#each contact.socials}}{{#if enabled}}| {{icon}} | [{{platform}}]({{url}}) |
+{{/if}}{{/each}}
+**Project Link:** [https://github.com/{{repository.github_username}}/{{repository.repo_name}}](https://github.com/{{repository.github_username}}/{{repository.repo_name}})
+{{/sections.contact.enabled}}
+
-
-
+
+{{#sections.acknowledgments.enabled}}
+
## 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!
+
+{{#sections.acknowledgments.items}}
+- [{{name}}]({{url}})
+{{/sections.acknowledgments.items}}
+
+{{/sections.acknowledgments.enabled}}
+
+
-[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
-[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
-[forks-url]: https://github.com/github_username/repo_name/network/members
-[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
-[stars-url]: https://github.com/github_username/repo_name/stargazers
-[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
-[issues-url]: https://github.com/github_username/repo_name/issues
-[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
-[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/linkedin_username
-[product-screenshot]: images/screenshot.png
-[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
-[Next-url]: https://nextjs.org/
-[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
-[React-url]: https://reactjs.org/
-[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
-[Vue-url]: https://vuejs.org/
-[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
-[Angular-url]: https://angular.io/
-[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
-[Svelte-url]: https://svelte.dev/
-[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
-[Laravel-url]: https://laravel.com
-[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
-[Bootstrap-url]: https://getbootstrap.com
-[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
-[JQuery-url]: https://jquery.com
+
+[contributors-shield]: https://img.shields.io/github/contributors/{{repository.github_username}}/{{repository.repo_name}}.svg?style=for-the-badge
+[contributors-url]: https://github.com/{{repository.github_username}}/{{repository.repo_name}}/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/{{repository.github_username}}/{{repository.repo_name}}.svg?style=for-the-badge
+[forks-url]: https://github.com/{{repository.github_username}}/{{repository.repo_name}}/network/members
+[stars-shield]: https://img.shields.io/github/stars/{{repository.github_username}}/{{repository.repo_name}}.svg?style=for-the-badge
+[stars-url]: https://github.com/{{repository.github_username}}/{{repository.repo_name}}/stargazers
+[issues-shield]: https://img.shields.io/github/issues/{{repository.github_username}}/{{repository.repo_name}}.svg?style=for-the-badge
+[issues-url]: https://github.com/{{repository.github_username}}/{{repository.repo_name}}/issues
+[license-shield]: https://img.shields.io/github/license/{{repository.github_username}}/{{repository.repo_name}}.svg?style=for-the-badge
+[license-url]: https://github.com/{{repository.github_username}}/{{repository.repo_name}}/blob/master/{{repository.license_file}}
+[product-screenshot]: {{project.screenshot_path}}
+{{#sections.built_with.frameworks}}
+[{{name}}.shield]: {{badge}}
+[{{name}}-url]: {{url}}
+{{/sections.built_with.frameworks}}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1ece0c3bd..81213c8e0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,27 +2,28 @@
## v1.1.2
-### Added or Changed
+### Added or Changed (v1.1.2)
+
- Change license to Unlicense; releasing the project fully into the public domain
- Add simplified project cover image
-
## v1.1.1
-### Added or Changed
-- Fixed back to top alignment (revert changes)
+### Added or Changed (v1.1.1)
+- Fixed back to top alignment (revert changes)
## v1.1.0
-### Added or Changed
+### Added or Changed (v1.1.0)
+
- Fixed back to top link alignment deprecated tag, use CSS style instead
- Added contrib.rocks to show top contributors
-
## v1.0.0
-### Added or Changed
+### Added or Changed (v1.0.0)
+
- Added this changelog :)
- Fixed typos in both templates
- Back to top links
@@ -32,4 +33,4 @@
### Removed
-- Some packages/libraries from acknowledgements I no longer use
\ No newline at end of file
+- Some packages/libraries from acknowledgements I no longer use
diff --git a/README.md b/README.md
index b36d4fd4d..1197fc68a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,3 @@
-
-
-
-
+
+
+
+
+
+
-
-
-
An awesome README template to jumpstart your projects!
- Explore the docs ยป
+
+ Explore the docs ยป
+
- View Demo
- ·
- Report Bug
- ·
- Request Feature
+
+ View Demo
+
+ ยท
+
+ Report Bug
+
+ ยท
+
+ Request Feature
+
| **Your Name** |
+| ๐ง | [email@example.com](mailto:email@example.com) |
+| ๐ | [@othneildrew](https://github.com/othneildrew) |
+| ๐ผ | [LinkedIn](https://linkedin.com/in/othneildrew) |
-Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
+**Project Link:** [https://github.com/othneildrew/Best-README-Template](https://github.com/othneildrew/Best-README-Template)
-
-
+
## 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!
+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)
+- [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)
-
-
+
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
@@ -260,22 +300,20 @@ Use this space to list resources you find helpful and would like to give credit
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png
-[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
-[Next-url]: https://nextjs.org/
-[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
+[Next.js.shield]: https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white
+[Next.js-url]: https://nextjs.org/
+[React.shield]: https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB
[React-url]: https://reactjs.org/
-[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
-[Vue-url]: https://vuejs.org/
-[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
+[Vue.js.shield]: https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D
+[Vue.js-url]: https://vuejs.org/
+[Angular.shield]: https://img.shields.io/badge/angular-%23DD0031.svg?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
-[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
+[Svelte.shield]: https://img.shields.io/badge/svelte-%23f1413d.svg?style=for-the-badge&logo=svelte&logoColor=white
[Svelte-url]: https://svelte.dev/
-[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
+[Laravel.shield]: https://img.shields.io/badge/laravel-%23FF2D20.svg?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
-[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
+[Bootstrap.shield]: https://img.shields.io/badge/bootstrap-%23563D7C.svg?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
-[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
-[JQuery-url]: https://jquery.com
+[jQuery.shield]: https://img.shields.io/badge/jquery-%230769AD.svg?style=for-the-badge&logo=jquery&logoColor=white
+[jQuery-url]: https://jquery.com
diff --git a/configs/example.json b/configs/example.json
new file mode 100644
index 000000000..3a3eb13f6
--- /dev/null
+++ b/configs/example.json
@@ -0,0 +1,186 @@
+{
+ "project": {
+ "title": "Best-README-Template",
+ "description": "An awesome README template to jumpstart your projects!",
+ "logo_path": "images/logo.png",
+ "screenshot_path": "images/screenshot.png"
+ },
+ "repository": {
+ "github_username": "othneildrew",
+ "repo_name": "Best-README-Template",
+ "license": "Unlicense License",
+ "license_file": "LICENSE.txt"
+ },
+ "contact": {
+ "name": "Your Name",
+ "email": "email@example.com",
+ "email_client": "example",
+ "socials": [
+ {
+ "platform": "LinkedIn",
+ "username": "othneildrew",
+ "url": "https://linkedin.com/in/othneildrew",
+ "icon": "๐ผ",
+ "enabled": true
+ },
+ {
+ "platform": "Twitter",
+ "username": "your_twitter",
+ "url": "https://twitter.com/your_twitter",
+ "icon": "๐ฆ",
+ "enabled": false
+ }
+ ]
+ },
+ "sections": {
+ "about": {
+ "enabled": true,
+ "content": "There are many great README templates available on GitHub; however, I didn't\nfind one that really suited my needs so I created this enhanced one. I want to\ncreate a README template so amazing that it'll be the last one you ever need--\nI think this is it.\n\nHere's why:\n\n- Your time should be focused on creating something amazing. A project that\nsolves a problem and helps others\n- You shouldn't be doing the same tasks over and over like creating a README\nfrom scratch\n- You should implement DRY principles to the rest of your life ๐\n\nOf course, no one template will serve all projects since your needs may be\ndifferent. So I'll be adding more in the near future. You may also suggest\nchanges by forking this repo and creating a pull request or opening an issue.\nThanks to all the people have contributed to expanding this template!\n\nUse the `BLANK_README.md` to get started."
+ },
+ "built_with": {
+ "enabled": true,
+ "frameworks": [
+ {
+ "name": "Next.js",
+ "url": "https://nextjs.org/",
+ "badge": "https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white"
+ },
+ {
+ "name": "React",
+ "url": "https://reactjs.org/",
+ "badge": "https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB"
+ },
+ {
+ "name": "Vue.js",
+ "url": "https://vuejs.org/",
+ "badge": "https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D"
+ },
+ {
+ "name": "Angular",
+ "url": "https://angular.io/",
+ "badge": "https://img.shields.io/badge/angular-%23DD0031.svg?style=for-the-badge&logo=angular&logoColor=white"
+ },
+ {
+ "name": "Svelte",
+ "url": "https://svelte.dev/",
+ "badge": "https://img.shields.io/badge/svelte-%23f1413d.svg?style=for-the-badge&logo=svelte&logoColor=white"
+ },
+ {
+ "name": "Laravel",
+ "url": "https://laravel.com",
+ "badge": "https://img.shields.io/badge/laravel-%23FF2D20.svg?style=for-the-badge&logo=laravel&logoColor=white"
+ },
+ {
+ "name": "Bootstrap",
+ "url": "https://getbootstrap.com",
+ "badge": "https://img.shields.io/badge/bootstrap-%23563D7C.svg?style=for-the-badge&logo=bootstrap&logoColor=white"
+ },
+ {
+ "name": "jQuery",
+ "url": "https://jquery.com",
+ "badge": "https://img.shields.io/badge/jquery-%230769AD.svg?style=for-the-badge&logo=jquery&logoColor=white"
+ }
+ ]
+ },
+ "getting_started": {
+ "enabled": true,
+ "prerequisites": [
+ { "name": "npm", "command": "npm install npm@latest -g" }
+ ],
+ "installation_steps": [
+ {
+ "text": "Get a free API Key at https://example.com",
+ "command": "# Register at https://example.com"
+ },
+ {
+ "text": "Clone the repo",
+ "command": "git clone https://github.com/your_username_/Project-Name.git",
+ "language": "bash"
+ },
+ {
+ "text": "Install NPM packages",
+ "command": "npm install",
+ "language": "bash"
+ },
+ {
+ "text": "Enter your API in `config.js`",
+ "command": "const API_KEY = 'ENTER YOUR API';"
+ },
+ {
+ "text": "Change git remote url to avoid accidental pushes to base project",
+ "command": "git remote set-url origin https://github.com/your_username_/Project-Name.git",
+ "language": "bash"
+ }
+ ]
+ },
+ "usage": {
+ "enabled": true,
+ "content": "Use this space to show useful examples of how a project can be used. Additional\nscreenshots, code examples and demos work well in this space. You may also link\nto more resources."
+ },
+ "roadmap": {
+ "enabled": true,
+ "items": [
+ { "text": "Add Changelog", "completed": true },
+ { "text": "Add back to top links", "completed": true },
+ { "text": "Add Additional Templates w/ Examples", "completed": true },
+ {
+ "text": "Add \"components\" document to easily copy & paste sections of\nthe readme",
+ "completed": true
+ },
+ {
+ "text": "Multi-language Support",
+ "completed": false,
+ "subitems": [
+ { "text": "Chinese", "completed": false },
+ { "text": "Spanish", "completed": false }
+ ]
+ }
+ ]
+ },
+ "contributing": {
+ "enabled": true,
+ "show_contributors": true
+ },
+ "license": {
+ "enabled": true
+ },
+ "contact": {
+ "enabled": true
+ },
+ "acknowledgments": {
+ "enabled": true,
+ "items": [
+ {
+ "name": "Choose an Open Source License",
+ "url": "https://choosealicense.com"
+ },
+ {
+ "name": "GitHub Emoji Cheat Sheet",
+ "url": "https://www.webpagefx.com/tools/emoji-cheat-sheet"
+ },
+ {
+ "name": "Malven's Flexbox Cheatsheet",
+ "url": "https://flexbox.malven.co/"
+ },
+ {
+ "name": "Malven's Grid Cheatsheet",
+ "url": "https://grid.malven.co/"
+ },
+ { "name": "Img Shields", "url": "https://shields.io" },
+ { "name": "GitHub Pages", "url": "https://pages.github.com" },
+ { "name": "Font Awesome", "url": "https://fontawesome.com" },
+ {
+ "name": "React Icons",
+ "url": "https://react-icons.github.io/react-icons/search"
+ }
+ ]
+ }
+ },
+ "badges": {
+ "contributors": true,
+ "forks": true,
+ "stars": true,
+ "issues": true,
+ "license": true
+ }
+}
diff --git a/docs/FAQ.md b/docs/FAQ.md
new file mode 100644
index 000000000..4d90dad35
--- /dev/null
+++ b/docs/FAQ.md
@@ -0,0 +1,272 @@
+# Frequently Asked Questions (FAQ)
+
+## Getting Started
+
+### What is the purpose of this template, and how can I use it for my own project?
+
+This README template provides a professional, comprehensive structure for
+documenting your projects. It includes:
+
+- **Clear project description** with logos and badges
+- **Installation and usage instructions**
+- **Contributing guidelines** to encourage community participation
+- **Professional formatting** that works across different platforms
+
+To use it for your project:
+
+1. Use the `BLANK_README.md` file as your starting point
+2. Search and replace placeholders with your actual information
+3. Customize sections to fit your project's needs
+4. Remove sections you don't need
+
+### How do I customize the template to fit my project's specific needs?
+
+The template is designed to be modular. Here's how to customize it:
+
+**Required customizations:**
+
+- `github_username` โ your GitHub username
+- `repo_name` โ your repository name
+- `project_title` โ your project name
+- `project_description` โ brief description of your project
+- `project_license` โ your chosen license (e.g., MIT, Apache-2.0, etc.)
+- `twitter_handle` โ your Twitter/X handle
+- `linkedin_username` โ your LinkedIn username
+- `email_client` โ your email provider (e.g., gmail, outlook)
+- `email` โ your email address
+
+**Optional customizations:**
+
+- Remove sections you don't need (Built With, Roadmap, etc.)
+- Add project-specific sections
+- Customize the color scheme of badges
+- Replace the logo with your own branding
+
+### How do I add more badges to my README?
+
+Badges are generated by [shields.io](https://shields.io). To add more badges:
+
+1. **Visit shields.io** and browse available badges
+2. **Generate the badge URL** for your specific repository
+3. **Add to the badges section** following this pattern:
+
+```markdown
+[![Badge Name][badge-shield]][badge-url]
+
+
+[badge-shield]: https://img.shields.io/badge/YOUR_BADGE_URL
+[badge-url]: https://your-link-here
+```
+
+**Popular additional badges:**
+
+- Build status: `[![Build Status][build-shield]][build-url]`
+- Code coverage: `[![Coverage][coverage-shield]][coverage-url]`
+- Dependencies: `[![Dependencies][deps-shield]][deps-url]`
+- Downloads: `[![Downloads][downloads-shield]][downloads-url]`
+- Version: `[![Version][version-shield]][version-url]`
+
+### Can I add my translation to the repository?
+
+Yes! Translations are welcome and help make the template accessible to more
+developers. Here are the ways to contribute translations:
+
+**For this template repository:**
+
+1. **Fork the repository**
+2. **Create translated versions** of key files:
+ - `README.es.md` (Spanish)
+ - `README.fr.md` (French)
+ - `README.zh.md` (Chinese)
+ - `docs/FAQ.es.md` (translated FAQ)
+3. **Translate section headers** and standard text
+4. **Keep technical examples** in English or provide localized examples
+5. **Submit a pull request** with your translation
+
+**For your own projects using this template:**
+
+1. **Create multiple README files** for different languages
+2. **Link between translations** in each file
+3. **Use consistent formatting** across all versions
+
+**Translation guidelines:**
+
+- Translate section headers and descriptive text
+- Keep code examples and technical terms consistent
+- Provide cultural context where appropriate
+- Maintain the same structure and formatting
+
+### What's the difference between README.md and BLANK_README.md?
+
+- **README.md** - Example template showing what the final result looks like
+- **BLANK_README.md** - Clean template with placeholders for you to customize
+
+### Do I need to keep both files?
+
+No! Use `BLANK_README.md` as your starting point, customize it, then rename it
+to `README.md` for your project. You can delete the original files.
+
+## Customization
+
+### How do I add my own logo?
+
+1. Add your logo image to the `images/` folder
+2. Update the logo reference in your README:
+
+ ```markdown
+ 
+ ```
+
+3. Update the `[product-screenshot]` reference at the bottom if needed
+
+### How do I customize the shields/badges?
+
+The shields are generated by [shields.io](https://shields.io). Update the URLs
+at the bottom of the template:
+
+```markdown
+[contributors-shield]: https://img.shields.io/github/contributors/YOUR_USERNAME/YOUR_REPO.svg?style=for-the-badge
+```
+
+Replace `YOUR_USERNAME` and `YOUR_REPO` with your actual GitHub username and
+repository name.
+
+### Can I remove sections I don't need?
+
+Absolutely! The template is designed to be modular. Common sections to remove:
+
+- **Built With** - if not using frameworks
+- **Roadmap** - for completed projects
+- **LinkedIn badge** - if you prefer not to include social links
+- **Table of Contents** - for simpler projects
+
+Just remember to also remove the corresponding links in the Table of Contents.
+
+### How do I add more sections?
+
+Follow the existing pattern:
+
+1. Add your section with proper markdown heading
+2. Add a "back to top" link:
+ ``
+3. Update the Table of Contents with a link to your new section
+
+## Markdown & Formatting
+
+### Why are there HTML tags in a markdown file?
+
+Some features require HTML for proper formatting:
+
+- **Image sizing** - Markdown can't specify width/height
+- **Center alignment** - Pure markdown doesn't support centering
+- **Collapsible sections** - `