1.1.2 Release

NickDJM · web-flow · commit a900f0e2cfa9 · 2019-04-03T15:29:37.000-04:00
* docs(usage): add basic information on how to use the plugins (#1) * feat(license): add isc license * feat(widths): add adjustable border-width variant * docs(global): add proper docs * docs(information): add more information about project * docs(border widths): add documentation * docs(temp): add placeholder templates * docs(classes): add btn-rounded documentation * docs(classes): add btn-squared documentation * docs(classes): add font-sizes documentation * feat(global): add commitizen ensure commits follow the same structure for readability. * docs(classes): update documentation structure * docs(classes): add documentation for col-count * docs(mixins): add documentation for media-ie * docs(other): add documentation for responsize typography * feat(version): update to 0.2.0 * feat(version): update to 0.2.0 * docs(usage): add basic information on how to use the plugins (#1) * feat(license): add isc license * feat(widths): add adjustable border-width variant * docs(global): add proper docs * docs(information): add more information about project * docs(border widths): add documentation * docs(temp): add placeholder templates * docs(classes): add btn-rounded documentation * docs(classes): add btn-squared documentation * docs(classes): add font-sizes documentation * feat(global): add commitizen ensure commits follow the same structure for readability. * docs(classes): update documentation structure * docs(classes): add documentation for col-count * docs(mixins): add documentation for media-ie * docs(other): add documentation for responsize typography * docs(community): add code of conduct * docs(community): add contributing guidelines * docs(community): add contribution documentation * docs(contribution): update pr steps * docs(contribution): fix links to issues * test(global): add lint and compiling tests * test(gulp): add initial testing setup * fix(plugin): rename squared buttons file * test(global): make tests work * chore(templates): add templates * docs(community): move code of conduct and contributing docs * chore(templates): add templates * chore(templates): add new templates * chore(templates): add new templates * chore(templates): remove old template * refactor(version): update to 1.0.0 * fix(repo): change repo url BREAKING CHANGE: The repository has changed. * docs(log): add changelog * refactor(version): update to 1.0.0 * feat(plugin): add screen reader breakpoints * docs(tests): correct documentation * docs(tests): correct documentation * feat(class): add sr-breakpoint classes * docs(spelling): correct typo * feat(plugin): add transparent backgrounds plugin * feat(plugin): add 25 and 75 transparent background classes * feat(plugin): add opacity classes * docs(classes): change name of documentation file * docs(plugin): update bg-transparency with 25 and 75 * docs(plugin): remove file extension from example * docs(plugin): add more info for the sr-brakpoints documention * feat(plugin): add opacity plugin * refactor(version): update to 1.1.0 * docs(community): add code of conduct * docs(community): add contributing guidelines * docs(community): add contribution documentation * docs(contribution): update pr steps * docs(contribution): fix links to issues * chore(templates): add templates * docs(community): move code of conduct and contributing docs * chore(templates): add templates * chore(templates): add new templates * chore(templates): add new templates * chore(templates): remove old template * refactor(version): update to 1.0.0 * fix(repo): change repo url BREAKING CHANGE: The repository has changed. * docs(log): add changelog * refactor(version): update to 1.0.0 * feat(plugin): add screen reader breakpoints * docs(tests): correct documentation * docs(tests): correct documentation * feat(class): add sr-breakpoint classes * docs(spelling): correct typo * feat(plugin): add transparent backgrounds plugin * feat(plugin): add 25 and 75 transparent background classes * feat(plugin): add opacity classes * docs(classes): change name of documentation file * docs(plugin): update bg-transparency with 25 and 75 * docs(plugin): remove file extension from example * docs(plugin): add more info for the sr-brakpoints documention * feat(plugin): add opacity plugin * refactor(version): update to 1.1.0 * docs(community): add code of conduct * docs(community): add contributing guidelines * docs(community): add contribution documentation * docs(contribution): update pr steps * docs(contribution): fix links to issues * chore(templates): add templates * docs(community): move code of conduct and contributing docs * chore(templates): add templates * chore(templates): add new templates * chore(templates): add new templates * chore(templates): remove old template * refactor(version): update to 1.0.0 * fix(repo): change repo url BREAKING CHANGE: The repository has changed. * docs(log): add changelog * refactor(version): update to 1.0.0 * feat(plugin): add screen reader breakpoints * docs(tests): correct documentation * docs(tests): correct documentation * feat(class): add sr-breakpoint classes * docs(spelling): correct typo * docs(community): add code of conduct * docs(community): add contributing guidelines * docs(community): add contribution documentation * docs(contribution): update pr steps * docs(contribution): fix links to issues * chore(templates): add templates * docs(community): move code of conduct and contributing docs * chore(templates): add templates * chore(templates): add new templates * chore(templates): add new templates * chore(templates): remove old template * refactor(version): update to 1.0.0 * fix(repo): change repo url BREAKING CHANGE: The repository has changed. * docs(log): add changelog * refactor(version): update to 1.0.0 * feat(plugin): add screen reader breakpoints * docs(tests): correct documentation * docs(tests): correct documentation * feat(class): add sr-breakpoint classes * docs(spelling): correct typo * feat(plugin): add transparent backgrounds plugin * feat(plugin): add opacity classes * docs(classes): change name of documentation file * docs(plugin): update bg-transparency with 25 and 75 * docs(plugin): remove file extension from example * docs(plugin): add more info for the sr-brakpoints documention * feat(plugin): add opacity plugin * feat(plugin): add transparent backgrounds plugin * feat(plugin): add opacity classes * docs(classes): change name of documentation file * docs(plugin): update bg-transparency with 25 and 75 * docs(plugin): remove file extension from example * docs(plugin): add more info for the sr-brakpoints documention * feat(plugin): add opacity plugin * docs(info): correct license and spelling issues * refactor(structure): move github specific docs * fix(text-shadow): remove shadow offset * refactor(structure): move github specific docs * fix(text-shadow): create new variable to hold negative width * refactor(version): update to 1.1.1 * docs(package): update general docs * docs(contrib): update email * docs(readme): update wording of feature list Fixes #42 * docs(readme): correct spelling * docs(readme): add shields icons * chore(version): 1.1.2 * docs(readme): correct link * chore(version): 1.1.2
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -52,7 +52,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at support@coldfrontlabs.ca. All
+reported by contacting the project team at developers@coldfrontlabs.ca. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.2
+
+- Clean up documentation (specifically in the main readme)
+
 ## 1.1.1
 
 - Fix issue causing text-shadow classes to look offset
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # bootstrap-scss-plugins
 
+[![NPM Version](https://img.shields.io/npm/v/bootstrap-scss-plugins.svg?style=for-the-badge)](https://www.npmjs.org/package/bootstrap-scss-plugins)
+[![NPM Downloads](https://img.shields.io/npm/dt/bootstrap-scss-plugins.svg?style=for-the-badge)](https://www.npmjs.com/package/bootstrap-scss-plugins)
+[![License](https://img.shields.io/github/license/coldfrontlabs/bootstrap-scss-plugins.svg?style=for-the-badge)](/LICENSE)
+
 A suite of SCSS plugins used for developing Bootstrap 4 themes and sites.
 
 This package aims to add a few useful classes and mixins, not found in "vanilla" Bootstrap 4, to help speed up the development of websites.
@@ -27,26 +31,26 @@ There are a couple ways to use the plugins, but all steps begin with importing t
 @import 'path/to/node_modules/bootstrap-scss-plugins/scss/font-sizes';
 ```
 
-Once you have imported all the files you need, you can simply use the classes and mixins are you would any other Bootstrap feature.
+Once you have imported all the files you need, you can simply use the classes and mixins as you would any other Bootstrap feature.
 
 For more detailed usage of each plugin, please see the docs.
 
 ## Classes
 
-- `.bg-colour-n`: Sets background colours with transparency - [Full documentation](docs/class/bg-transparency.md)
-- `.border-width-n`: Sets the width of borders. - [Full documentation](docs/classes/border-widths.md)
-- `.btn-rounded`: Rounds the corners of buttons. - [Full documentation](docs/classes/btn-rounded.md)
-- `.btn-squared`: Squares off the corners of buttons. - [Full documentation](docs/classes/btn-squared.md)
-- `.col-count-n`: Sets the column count of groups. - [Full documentation](docs/classes/col-count.md)
-- `.font-size-x`: Sets the font size of text. - [Full documentation](docs/classes/font-sizes.md)
-- `.o-n`: Sets the opacity of an element. - [Full documentation](docs/classes/opacity.md)
-- `.sr-x-only`: Breakpoint selectors for the `.sr-only` class - [Full documentation](docs/classes/sr-breakpoints.md)
-- `.text-outline`: Outlines text. - [Full documentation](docs/classes/text-outline.md)
+- [Transparent backgrounds](docs/class/bg-transparency.md)
+- [Border widths](docs/classes/border-widths.md)
+- [Rounded buttons](docs/classes/btn-rounded.md)
+- [Squared buttons](docs/classes/btn-squared.md)
+- [Card group column count](docs/classes/col-count.md)
+- [Font sizes](docs/classes/font-sizes.md)
+- [Opacity](docs/classes/opacity.md)
+- [Screen reader breakpoints](docs/classes/sr-breakpoints.md)
+- [Text outline](docs/classes/text-outline.md)
 
 ## Mixins
 
-- `media-ie`: Media queries to for Internet Explorer. - [Full documentation](docs/mixins/media-ie.md)
+- [IE media queries](docs/mixins/media-ie.md)
 
 ## Other Features
 
-- Responsive typography - [Full documentation](docs/other/responsive-typography.md)
+- [Responsive typography](docs/other/responsive-typography.md)
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bootstrap-scss-plugins",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A suite of SCSS plugins used for developing Bootstrap 4 themes and sites.",
   "eslintConfig": "./.eslintrc.js",
   "scripts": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "bootstrap-scss-plugins",`
`3`		`- "version": "1.1.1",`
	`3`	`+ "version": "1.1.2",`
`4`	`4`	`"description": "A suite of SCSS plugins used for developing Bootstrap 4 themes and sites.",`
`5`	`5`	`"eslintConfig": "./.eslintrc.js",`
`6`	`6`	`"scripts": {`