Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite readme.md #618

Merged
merged 71 commits into from
Nov 10, 2023
Merged
Changes from all commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
98fd022
Add dark-mode to logo
crftwrk Nov 5, 2023
0dfc65b
Update README.md
crftwrk Nov 5, 2023
d941509
Update README.md
crftwrk Nov 5, 2023
c8811ce
Update README.md
crftwrk Nov 5, 2023
750c9f5
Update README.md
crftwrk Nov 5, 2023
99471de
Update README.md
crftwrk Nov 5, 2023
1b56fe9
Update README.md
crftwrk Nov 5, 2023
951e628
Update README.md
crftwrk Nov 5, 2023
506fabf
Update README.md
crftwrk Nov 5, 2023
35f34e3
Update README.md
crftwrk Nov 5, 2023
1a120e8
Update README.md
crftwrk Nov 5, 2023
ab1751a
Update README.md
crftwrk Nov 5, 2023
6a07aae
Update README.md
crftwrk Nov 5, 2023
e6b4d79
Update README.md
crftwrk Nov 5, 2023
7586717
Update README.md
crftwrk Nov 5, 2023
b098fa7
Update README.md
crftwrk Nov 5, 2023
dd0d2c8
Update README.md
crftwrk Nov 5, 2023
0916850
Update README.md
crftwrk Nov 5, 2023
146f8ab
Update README.md
crftwrk Nov 5, 2023
8785ba8
Update README.md
crftwrk Nov 5, 2023
b085262
Update README.md
crftwrk Nov 5, 2023
6ac2185
Update README.md
crftwrk Nov 5, 2023
400a0ed
Improve download link
crftwrk Nov 5, 2023
eb9a74b
Update README.md
crftwrk Nov 5, 2023
c5d0d35
Update README.md
crftwrk Nov 5, 2023
927191c
Update README.md
crftwrk Nov 5, 2023
f7c3424
Update README.md
crftwrk Nov 5, 2023
b242ba8
Update README.md
crftwrk Nov 5, 2023
502dad2
Update README.md
crftwrk Nov 5, 2023
0893852
Improve license links
crftwrk Nov 5, 2023
cd03b7e
Improve license links
crftwrk Nov 5, 2023
df88ab8
Update README.md
crftwrk Nov 5, 2023
f2db7d9
Update README.md
crftwrk Nov 5, 2023
a6205cc
Update README.md
crftwrk Nov 5, 2023
79c9965
Update README.md
crftwrk Nov 5, 2023
f0a0593
Update README.md
crftwrk Nov 5, 2023
3873fad
Update README.md
crftwrk Nov 5, 2023
29945ca
Update README.md
crftwrk Nov 5, 2023
4c8f21b
Update README.md
crftwrk Nov 5, 2023
0c24d0b
Update README.md
crftwrk Nov 5, 2023
16bc55e
Update README.md
crftwrk Nov 5, 2023
db87fa2
Update README.md
crftwrk Nov 5, 2023
0dd9437
Update README.md
crftwrk Nov 5, 2023
c80c6b0
Update README.md
crftwrk Nov 5, 2023
cdfed42
Update README.md
crftwrk Nov 5, 2023
ec2abe2
Update README.md
crftwrk Nov 5, 2023
4a27347
Update README.md
crftwrk Nov 5, 2023
81933d2
Update README.md
crftwrk Nov 5, 2023
1d09774
Update README.md
crftwrk Nov 5, 2023
05fa8a1
Update README.md
crftwrk Nov 5, 2023
2a824ff
Update README.md
crftwrk Nov 5, 2023
6661d0b
Update README.md
crftwrk Nov 5, 2023
a0bfcfb
Update README.md
crftwrk Nov 5, 2023
324ef61
Update README.md
crftwrk Nov 5, 2023
a5330c2
Update README.md
crftwrk Nov 5, 2023
318cd85
Update README.md
crftwrk Nov 5, 2023
f08ceb1
Update README.md
crftwrk Nov 5, 2023
b6ff801
Update README.md
crftwrk Nov 5, 2023
f603eee
Update README.md
crftwrk Nov 5, 2023
5bb6938
Update README.md
crftwrk Nov 5, 2023
a7e05e4
Update README.md
crftwrk Nov 5, 2023
02d4209
Update README.md
crftwrk Nov 5, 2023
cbeed14
Update README.md
crftwrk Nov 5, 2023
36e9773
Update README.md
crftwrk Nov 5, 2023
c92da60
Update README.md
crftwrk Nov 5, 2023
47b5858
Update README.md
crftwrk Nov 5, 2023
658d686
Update README.md
crftwrk Nov 9, 2023
b9e5e71
Update README.md
crftwrk Nov 9, 2023
dd91054
Update README.md
crftwrk Nov 9, 2023
628d549
Update README.md
crftwrk Nov 9, 2023
0c28562
Update README.md
crftwrk Nov 9, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 65 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,93 @@
[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)

<br>
<div align="center">
<img src="https://raw.githubusercontent.com/craftwerkberlin/bootscore-5/main/img/logo/logo.svg" height="50">
<p>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github-production-user-asset-6210df.s3.amazonaws.com/51531217/279796754-be3e5050-8bcc-478c-aac8-d3522b9af351.svg">
<source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/51531217/279796586-11ab7ee1-aff5-4960-99eb-c21c0ccbdec5.svg">
<img alt="bootScore logo light/dark mode" src="https://user-images.githubusercontent.com/51531217/279796586-11ab7ee1-aff5-4960-99eb-c21c0ccbdec5.svg" height="50">
</picture>
</p>

Intuitive Bootstrap WordPress starter-theme and time-saving plugins

[Theme](https://bootscore.me/theme/) • [Plugins](https://bootscore.me/plugins/) • [Shop](https://bootscore.me/shop/) • [Docs](https://bootscore.me/documentation/) • [Blog](https://bootscore.me/blog/) • [Community](https://github.com/orgs/bootscore/discussions)

<h1></h1>
</div>

<br>
<div align="center">
<h1>Bootstrap 5 + WordPress starter theme</h1>
</div>
<a href="https://vshymanskyy.github.io/StandWithUkraine"><img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg" width="500"></a>
</div>
<br>

# bootScore
bootScore combines [Bootstrap](https://getbootstrap.com) and the [Underscores](https://underscores.me) theme boiler template in a compact starter theme for outstanding [WordPress](https://wordpress.org/) projects. It does not include customizer settings, logo upload functionality, or drag-and-drop features. Customization in bootScore is entirely achievable through its `.php`, `.scss`, and `.js` files, requiring basic coding skills for editing.

Site: https://bootscore.me/
The Bootstrap source code is included, allowing easy on-the-fly editing Bootstrap without the need for Gulp, Node, or any other technical commands. Simply add your styles, save, and let the built-in [scssphp](https://github.com/scssphp/scssphp) compiler do the rest.

Docs: https://bootscore.me/category/documentation/
bootScore comes with full [WooCommerce](https://woo.com/) support, featuring an integrated AJAX offcanvas cart.

bootScore combines the Underscores theme boiler template with Bootstrap 5 in a small starter theme for great WordPress projects. There are no settings in the customizer, no logo-uploader and no drag'n'drop. bootScore is 100% customizable by using the .php, .scss and .js files. Basic coding skills for editing are required.
This time-saving tool is designed to swiftly create clean, mobile-first projects. If you are familiar with Bootstrap and its HTML classes, you'll feel right at home and be able to build whatever you desire.

bootScore comes with seamless Bootstrap integration and full WooCommerce support with an integrated ajax offcanvas cart.
[![Packagist Prerelease](https://img.shields.io/packagist/vpre/bootscore/bootscore?logo=packagist&logoColor=fff)](https://packagist.org/packages/bootscore/bootscore)
[![Backers on Open Collective](https://img.shields.io/opencollective/backers/bootscore?logo=opencollective&logoColor=fff)](https://opencollective.com/bootscore)
[![GitHub Sponsors](https://img.shields.io/github/sponsors/bootscore?logo=github)](https://github.com/sponsors/bootscore)

## Installation
## Table of contents
- [Installation](#installation)
- [Child-theme](#child-theme)
- [Plugins](#plugins)
- [Support & contribute](#support--contribute)
- [Discussions](#discussions)
- [Issues](#issues)
- [Pull requests](#pull-requests)
- [Blog & Twitter](#blog--twitter)
- [Sponsor this project](#sponsor-this-project)
- [License & credits](#license--credits)

1. Download latest release [bootscore-main.zip](https://github.com/bootscore/bootscore/releases) or get bootScore through the official [site](https://bootscore.me/#download).
2. Upload theme via the WordPress theme-uploader and activate it.
## Installation
1. Download latest release [bootscore-main.zip](https://github.com/bootscore/bootscore/releases/latest/download/bootscore-main.zip).
2. In your admin panel, go to **Appearance** > **Themes** and click the **Add New** button.
3. Click **Upload Theme** and **Choose File**, then select `bootscore-main.zip` file. Click **Install Now**.
4. Click **Activate** to use your new theme right away.

### Composer

Read [here](https://bootscore.me/documentation/installation/) how to install bootScore via Composer.
To install using Composer, you will need to have Composer installed on your system. Ideally, it should also be available on your server with command-line access, although this is not mandatory. For detailed instructions on installing with Composer, please read the [documentation](https://bootscore.me/documentation/installation/#Composer).

## Child-theme
Edit the theme in an upgrade-safe manner by using the provided [bootScore Child](https://github.com/bootscore/bootscore-child). Note that the child theme is not a stand-alone theme, bootScore must be installed for it to function.

Edit theme in an upgrade-safe way using the provided [bootScore Child](https://github.com/bootscore/bootscore-child).
### Installation
1. Download latest release [bootscore-child-main.zip](https://github.com/bootscore/bootscore-child/releases/latest/download/bootscore-child-main.zip).
2. In your admin panel, go to **Appearance** > **Themes** and click the **Add New** button.
3. Click **Upload Theme** and **Choose File**, then select `bootscore-child-main.zip` file. Click **Install Now**.
4. Click **Activate** to use your new child-theme right away.

## Plugins
Extend bootScore with small yet useful [plugins](https://bootscore.me/plugins/). Each plugin either utilizes Bootstrap or integrates it into third-party plugins.

Extend bootScore with tiny but usefull [plugins](https://bootscore.me/plugins/). Each plugin uses Bootstrap or adds it to 3rd party plugins.

## Workflow

bootScore is a time-saver and designed to quickly create clean mobile-first projects. If you are familiar with Bootstrap classes and HTML, you will feel like home and be able to build whatever you want.

## Help
## Support & contribute

### Discussions
Check the [documentation](https://bootscore.me/category/documentation/). If you have a general question or need help with your project, feel free to open a new [discussion](https://github.com/bootscore/bootscore/discussions). Maybe your question is in [help wanted](https://github.com/bootscore/bootscore/issues?q=is%3Aissue+label%3A%22help+wanted%22+) labeled issues already solved.
If you have a general question that is not answered in the [documentation](https://bootscore.me/category/documentation/) or need help with your project, feel free to open a new [discussion](https://github.com/orgs/bootscore/discussions). Your question might already have been resolved in issues labeled [help wanted](https://github.com/bootscore/bootscore/issues?q=is%3Aissue+label%3A%22help+wanted%22+).

### Issues
If you find a bug or have a feature idea, you're welcome to open an [issue](https://github.com/bootscore/bootscore/issues). Please check [closed issues](https://github.com/bootscore/bootscore/issues?q=is%3Aissue+is%3Aclosed) first to avoid duplicates.

### Blog & Twitter
For important updates read the [blog](https://bootscore.me/category/blog/) and follow us on [Twitter](https://twitter.com/_bootscore). You will be informed if there is something new you should know.
If you find a bug or have a feature idea, feel welcome to open an [issue](https://github.com/bootscore/bootscore/issues). Before submitting, kindly check [closed issues](https://github.com/bootscore/bootscore/issues?q=is%3Aissue+is%3Aclosed) to avoid duplicates. Note that bug reports **must include a link to a reduced test case**.

### Pull requests
We’re delighted if you'd like to contribute. Simply fork the repository, make your changes, and create a pull request. Every PR will be reviewed, and if everything looks good, we’ll merge your changes into the `main` branch.

We’re happy if you want to contribute. Just fork the repository, do your changes and create a pull request. Every PR will be reviewed. If everything is fine we’ll merge your changes to the `main` branch.

## License & Credits

- bootScore, MIT License https://github.com/bootscore/bootscore/blob/main/LICENSE
- Bootstrap, MIT License https://github.com/twbs/bootstrap/blob/main/LICENSE
- Bootstrap 5 WordPress Navbar Walker by AlexWebLab, MIT License https://github.com/AlexWebLab/bootstrap-5-wordpress-navbar-walker/blob/main/LICENSE
- Font Awesome Free License https://fontawesome.com/license/free
- scssphp by Leaf Corcoran, MIT License https://github.com/scssphp/scssphp/blob/master/LICENSE.md
- Plugin Update Checker by YahnisElsts, MIT License https://github.com/YahnisElsts/plugin-update-checker/blob/master/license.txt
### Blog & Twitter
For important updates, read our [blog](https://bootscore.me/category/blog/) and follow us on [Twitter](https://twitter.com/_bootscore). This way, you'll stay informed about anything new that you should know.

## Sponsor this project
Like what you see? You can support us by [sponsoring](https://github.com/sponsors/bootscore) this project. Every contribution is highly appreciated, as it helps us maintain high motivation and continually develop the project.

## License & Credits
- bootScore, [MIT License](https://github.com/bootscore/bootscore/blob/main/LICENSE)
- Bootstrap, [MIT License](https://github.com/twbs/bootstrap/blob/main/LICENSE)
- Bootstrap 5 WordPress Navbar Walker by AlexWebLab, [MIT License](https://github.com/AlexWebLab/bootstrap-5-wordpress-navbar-walker/blob/main/LICENSE)
- Font Awesome [Free License](https://fontawesome.com/license/free)
- scssphp by Leaf Corcoran, [MIT License](https://github.com/scssphp/scssphp/blob/master/LICENSE.md)
- Plugin Update Checker by YahnisElsts, [MIT License](https://github.com/YahnisElsts/plugin-update-checker/blob/master/license.txt)