Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rstrangh committed Feb 18, 2022
1 parent 0b16b57 commit 92b2eb1
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# INNOQ Bootstrap 4 Theme
# INNOQ Bootstrap 5 Theme

[![npm version](https://badge.fury.io/js/innoq-bootstrap-theme.svg)](https://www.npmjs.com/package/innoq-bootstrap-theme)

## Usage

This theme is a complete replacement for Bootstrap 4. You do not need to include
This theme is a complete replacement for Bootstrap 5. You do not need to include
both, `bootstrap.css` and `innoq-bootstrap-theme.css`. The latter is sufficient.

To use the compiled theme in your webapp, you can either link to our CDN

https://bootstrap.assets.innoq.com/css/X.X.X/innoq-bootstrap-theme.css

(replace x.x.x by your desired version) or copy the contents of a certain
[release](https://github.com/innoq/innoq-bootstrap-theme/releases) to your
designated asset folder or use NPM to install this theme as a dependency.
[release][theme-release] to your designated asset folder or use NPM to install this theme as a dependency.

npm install innoq-bootstrap-theme --save

Expand All @@ -22,7 +21,7 @@ with NPM you can import the source files to your manifest (e.g. `index.scss`)
as well.

```scss
@import "innoq-bootstrap-theme/src/styles/index.scss";
@import "innoq-bootstrap-theme/src/styles/innoq-bootstrap-theme.scss";
```

**Please note:** This theme styles _all_ default Bootstrap components compliant
Expand All @@ -32,10 +31,13 @@ please head over to

<https://getbootstrap.com>

**Important:** If you are currently using Bootstrap 3 you should be aware that
version 4 brings some *breaking changes*. Do not update to the new theme without
**Important:** If you are currently using Bootstrap 4 you should be aware that
version 5 brings some _breaking changes_. Do not update to the new theme without
updating your webapp's views as well. If you need help with that check out this
[official migration guide](https://getbootstrap.com/docs/4.0/migration/).
[official migration guide][bootstrap-migration].

If you need the according JavaScript bundle from Bootstrap, please use either the Bootstraps CDN link
or the files that the bootstrap npm package provides. See more details [here][bootstrap-getting-started].


## Development
Expand All @@ -49,16 +51,18 @@ pages locally.

### Setup

* Install ruby 2.6 or higher
* Install node v10 or higher
* Install node v12 or higher

* Clone project `git clone git@github.com:innoq/innoq-bootstrap-theme.git`
* Go into the project folder `cd innoq-bootstrap-theme`
* Init the Bootstrap submodule `git submodule update --init` (only needed the
very first time)
* Install Bootstap's documentation pages `npm run docs:install`
* Compile styles and serve documentation `npm start`

Now you should see the Bootstrap documentation pages with INNOQ styling applied.
`npm start` incorporates a watcher, so you can write code and see your
changes immediately in the browser.

[theme-release]: https://github.com/innoq/innoq-bootstrap-theme/releases
[bootstrap-migration]: https://getbootstrap.com/docs/5.1/migration/
[bootstrap-getting-started]: https://getbootstrap.com/docs/5.1/getting-started/javascript/

0 comments on commit 92b2eb1

Please sign in to comment.