style(refactor): refactoring and updated project structure

Author: wessberg

CHANGELOG.md

@@ -1,85 +1,39 @@
-<a name="1.0.17"></a>
-## [1.0.17](https://github.com/wessberg/stringutil/compare/v1.0.16...v1.0.17) (2018-06-20)
-
+## [1.0.18](https://github.com/wessberg/stringutil/compare/v1.0.17...v1.0.18) (2018-10-18)
 
+### Features
 
-<a name="1.0.16"></a>
-## [1.0.16](https://github.com/wessberg/stringutil/compare/v1.0.15...v1.0.16) (2018-05-04)
+- Added a new function: 'truncate' ([9241795](https://github.com/wessberg/stringutil/commit/92417959f08578ada494d285629b4437fa583abf))
 
+## [1.0.17](https://github.com/wessberg/stringutil/compare/v1.0.16...v1.0.17) (2018-06-20)
 
+## [1.0.16](https://github.com/wessberg/stringutil/compare/v1.0.15...v1.0.16) (2018-05-04)
 
-<a name="1.0.15"></a>
 ## [1.0.15](https://github.com/wessberg/stringutil/compare/v1.0.14...v1.0.15) (2018-03-31)
 
-
-
-<a name="1.0.14"></a>
 ## [1.0.14](https://github.com/wessberg/stringutil/compare/v1.0.13...v1.0.14) (2018-02-03)
 
-
-
-<a name="1.0.13"></a>
 ## [1.0.13](https://github.com/wessberg/stringutil/compare/v1.0.12...v1.0.13) (2017-10-28)
 
-
-
-<a name="1.0.12"></a>
 ## [1.0.12](https://github.com/wessberg/stringutil/compare/v1.0.11...v1.0.12) (2017-10-22)
 
-
-
-<a name="1.0.11"></a>
 ## [1.0.11](https://github.com/wessberg/stringutil/compare/v1.0.10...v1.0.11) (2017-10-22)
 
-
-
-<a name="1.0.10"></a>
 ## [1.0.10](https://github.com/wessberg/stringutil/compare/v1.0.9...v1.0.10) (2017-08-20)
 
-
-
-<a name="1.0.9"></a>
 ## [1.0.9](https://github.com/wessberg/stringutil/compare/v1.0.8...v1.0.9) (2017-08-20)
 
-
-
-<a name="1.0.8"></a>
 ## [1.0.8](https://github.com/wessberg/stringutil/compare/v1.0.7...v1.0.8) (2017-08-08)
 
-
-
-<a name="1.0.7"></a>
 ## [1.0.7](https://github.com/wessberg/stringutil/compare/v1.0.6...v1.0.7) (2017-08-08)
 
-
-
-<a name="1.0.6"></a>
 ## [1.0.6](https://github.com/wessberg/stringutil/compare/v1.0.5...v1.0.6) (2017-08-08)
 
-
-
-<a name="1.0.5"></a>
 ## [1.0.5](https://github.com/wessberg/stringutil/compare/v1.0.4...v1.0.5) (2017-07-11)
 
-
-
-<a name="1.0.4"></a>
 ## [1.0.4](https://github.com/wessberg/stringutil/compare/v1.0.3...v1.0.4) (2017-07-10)
 
-
-
-<a name="1.0.3"></a>
 ## [1.0.3](https://github.com/wessberg/stringutil/compare/v1.0.2...v1.0.3) (2017-07-10)
 
-
-
-<a name="1.0.2"></a>
 ## [1.0.2](https://github.com/wessberg/stringutil/compare/v1.0.1...v1.0.2) (2017-07-10)
 
-
-
-<a name="1.0.1"></a>
 ## 1.0.1 (2017-07-10)
-
-
-

CODE_OF_CONDUCT.md

@@ -14,21 +14,21 @@ Our Standards
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 Our Responsibilities
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting any of the code of conduct enforcers: [Frederik Wessberg](mailto:[email protected]).
+reported by contacting any of the code of conduct enforcers: [Frederik Wessberg](mailto:[email protected]) ([@FredWessberg](https://twitter.com/FredWessberg)) ([Website](https://github.com/wessberg)).
 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.
@@ -68,4 +68,4 @@ members of the project's leadership.
 Attribution
 
 This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
-available at http://contributor-covenant.org/version/1/4/
+available at http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -6,4 +6,4 @@ You are more than welcome to contribute to `@wessberg/stringutil` in any way you
 - Fixing issues and suggesting new features
 - Blogging, tweeting, and creating tutorials about `@wessberg/stringutil`
 - Reaching out to [@FredWessberg](https://twitter.com/FredWessberg) on Twitter
-- Submit an issue or a Pull Request
+- Submit an issue or a Pull Request

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2018 Frederik Wessberg <[email protected]>
+Copyright © 2019 [Frederik Wessberg](mailto:[email protected]) ([@FredWessberg](https://twitter.com/FredWessberg)) ([Website](https://github.com/wessberg))
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE
+SOFTWARE

README.md

@@ -1,17 +1,66 @@
-<a href="https://npmcharts.com/compare/@wessberg/stringutil?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/%40wessberg%2Fstringutil.svg" height="20"></img></a>
-<a href="https://david-dm.org/wessberg/stringutil"><img alt="Dependencies" src="https://img.shields.io/david/wessberg/stringutil.svg" height="20"></img></a>
-<a href="https://www.npmjs.com/package/@wessberg/stringutil"><img alt="NPM Version" src="https://badge.fury.io/js/%40wessberg%2Fstringutil.svg" height="20"></img></a>
-<a href="https://github.com/wessberg/stringutil/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/wessberg%2Fstringutil.svg" height="20"></img></a>
-<a href="https://opensource.org/licenses/MIT"><img alt="MIT License" src="https://img.shields.io/badge/License-MIT-yellow.svg" height="20"></img></a>
-<a href="https://www.patreon.com/bePatron?u=11315442"><img alt="Support on Patreon" src="https://c5.patreon.com/external/logo/[email protected]" height="20"></img></a>
+<!-- SHADOW_SECTION_LOGO_START -->
 
-# `@wessberg/stringutil`
+<!-- SHADOW_SECTION_LOGO_END -->
+
+<!-- SHADOW_SECTION_DESCRIPTION_SHORT_START -->
 
 > A collection of helper functions for working with strings
 
+<!-- SHADOW_SECTION_DESCRIPTION_SHORT_END -->
+
+<!-- SHADOW_SECTION_BADGES_START -->
+
+<a href="https://npmcharts.com/compare/%40wessberg%2Fstringutil?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/%40wessberg%2Fstringutil.svg"    /></a>
+<a href="https://www.npmjs.com/package/%40wessberg%2Fstringutil"><img alt="NPM version" src="https://badge.fury.io/js/%40wessberg%2Fstringutil.svg"    /></a>
+<a href="https://david-dm.org/wessberg/stringutil"><img alt="Dependencies" src="https://img.shields.io/david/wessberg%2Fstringutil.svg"    /></a>
+<a href="https://github.com/wessberg/stringutil/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/wessberg%2Fstringutil.svg"    /></a>
+<a href="https://github.com/prettier/prettier"><img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"    /></a>
+<a href="https://opensource.org/licenses/MIT"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg"    /></a>
+<a href="https://www.patreon.com/bePatron?u=11315442"><img alt="Support on Patreon" src="https://img.shields.io/badge/patreon-donate-green.svg"    /></a>
+
+<!-- SHADOW_SECTION_BADGES_END -->
+
+<!-- SHADOW_SECTION_DESCRIPTION_LONG_START -->
+
 ## Description
 
-A collection of helper functions for working with strings.
+<!-- SHADOW_SECTION_DESCRIPTION_LONG_END -->
+
+This library is a simple collection of helper functions for working with strings.
+
+<!-- SHADOW_SECTION_FEATURES_START -->
+
+### Features
+
+<!-- SHADOW_SECTION_FEATURES_END -->
+
+- Various helpers for changing and checking casing
+- Helpers for changing and checking quoting
+
+<!-- SHADOW_SECTION_FEATURE_IMAGE_START -->
+
+<!-- SHADOW_SECTION_FEATURE_IMAGE_END -->
+
+<!-- SHADOW_SECTION_TOC_START -->
+
+## Table of Contents
+
+- [Description](#description)
+  - [Features](#features)
+- [Table of Contents](#table-of-contents)
+- [Install](#install)
+  - [NPM](#npm)
+  - [Yarn](#yarn)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [Maintainers](#maintainers)
+- [Backers](#backers)
+  - [Patreon](#patreon)
+- [License](#license)
+
+<!-- SHADOW_SECTION_TOC_END -->
+
+<!-- SHADOW_SECTION_INSTALL_START -->
 
 ## Install
 
@@ -27,8 +76,14 @@ $ npm install @wessberg/stringutil
 $ yarn add @wessberg/stringutil
 ```
 
+<!-- SHADOW_SECTION_INSTALL_END -->
+
+<!-- SHADOW_SECTION_USAGE_START -->
+
 ## Usage
 
+<!-- SHADOW_SECTION_USAGE_END -->
+
 ```typescript
 import {camelCase, allIndexesOf} from "@wessberg/stringutil";
 camelCase("my-string"); // returns 'myString'
@@ -38,18 +93,40 @@ camelCase("my-complex_string HAS a_SPACE"); // returns 'myComplexStringHasASpace
 allIndexesOf(/_/g, "my string has underscores _here_"); // returns [26, 31]
 ```
 
+<!-- SHADOW_SECTION_CONTRIBUTING_START -->
+
 ## Contributing
 
 Do you want to contribute? Awesome! Please follow [these recommendations](./CONTRIBUTING.md).
 
+<!-- SHADOW_SECTION_CONTRIBUTING_END -->
+
+<!-- SHADOW_SECTION_MAINTAINERS_START -->
+
 ## Maintainers
 
-- <a href="https://github.com/wessberg"><img alt="Frederik Wessberg" src="https://avatars2.githubusercontent.com/u/20454213?s=460&v=4" height="11"></img></a> [Frederik Wessberg](https://github.com/wessberg): _Maintainer_
+| <img alt="Frederik Wessberg" src="https://avatars2.githubusercontent.com/u/20454213?s=460&v=4" height="70"   />                                                                                                                  |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Frederik Wessberg](mailto:[email protected])<br><strong>Twitter</strong>: [@FredWessberg](https://twitter.com/FredWessberg)<br><strong>Github</strong>: [@wessberg](https://github.com/wessberg)<br>_Lead Developer_ |
+
+<!-- SHADOW_SECTION_MAINTAINERS_END -->
+
+<!-- SHADOW_SECTION_BACKERS_START -->
+
+## Backers
+
+### Patreon
+
+[Become a backer](https://www.patreon.com/bePatron?u=11315442) and get your name, avatar, and Twitter handle listed here.
+
+<a href="https://www.patreon.com/bePatron?u=11315442"><img alt="Backers on Patreon" src="https://patreon-badge.herokuapp.com/11315442.png"  width="500"  /></a>
+
+<!-- SHADOW_SECTION_BACKERS_END -->
 
-## Backers 🏅
+<!-- SHADOW_SECTION_LICENSE_START -->
 
-[Become a backer](https://www.patreon.com/bePatron?u=11315442) and get your name, logo, and link to your site listed here.
+## License
 
-## License 📄
+MIT © [Frederik Wessberg](mailto:[email protected]) ([@FredWessberg](https://twitter.com/FredWessberg)) ([Website](https://github.com/wessberg))
 
-MIT © [Frederik Wessberg](https://github.com/wessberg)
+<!-- SHADOW_SECTION_LICENSE_END -->