Rebuilt readme with tldw

Jaid · Feb 1, 2020 · 9257aca · 9257aca
1 parent 8244f2c
commit 9257aca
Showing 1 changed file with 32 additions and 12 deletions.
diff --git a/readme.md b/readme.md
@@ -1,7 +1,7 @@
 # crop-string
 
 
-<a href="https://raw.githubusercontent.com/jaid/crop-string/master/license.txt"><img src="https://img.shields.io/github/license/jaid/crop-string?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor crop-string"/></a>
+<a href="https://raw.githubusercontent.com/jaid/crop-string/master/license.txt"><img src="https://img.shields.io/github/license/jaid/crop-string?style=flat-square" alt="License"/></a> <a href="https://github.com/sponsors/jaid"><img src="https://img.shields.io/badge/<3-Sponsor-FF45F1?style=flat-square" alt="Sponsor crop-string"/></a>  
 <a href="https://actions-badge.atrox.dev/jaid/crop-string/goto"><img src="https://img.shields.io/endpoint.svg?style=flat-square&url=https%3A%2F%2Factions-badge.atrox.dev%2Fjaid%2Fcrop-string%2Fbadge" alt="Build status"/></a> <a href="https://github.com/jaid/crop-string/commits"><img src="https://img.shields.io/github/commits-since/jaid/crop-string/v2.0.0?style=flat-square&logo=github" alt="Commits since v2.0.0"/></a> <a href="https://github.com/jaid/crop-string/commits"><img src="https://img.shields.io/github/last-commit/jaid/crop-string?style=flat-square&logo=github" alt="Last commit"/></a> <a href="https://github.com/jaid/crop-string/issues"><img src="https://img.shields.io/github/issues/jaid/crop-string?style=flat-square&logo=github" alt="Issues"/></a>  
 <a href="https://npmjs.com/package/crop-string"><img src="https://img.shields.io/npm/v/crop-string?style=flat-square&logo=npm&label=latest%20version" alt="Latest version on npm"/></a> <a href="https://github.com/jaid/crop-string/network/dependents"><img src="https://img.shields.io/librariesio/dependents/npm/crop-string?style=flat-square&logo=npm" alt="Dependents"/></a> <a href="https://npmjs.com/package/crop-string"><img src="https://img.shields.io/npm/dm/crop-string?style=flat-square&logo=npm" alt="Downloads"/></a>
 
@@ -11,28 +11,42 @@
 
 
 
+## Installation
 
+<a href="https://npmjs.com/package/crop-string"><img src="https://img.shields.io/badge/npm-crop--string-C23039?style=flat-square&logo=npm" alt="crop-string on npm"/></a>
 
+```bash
+npm install --save crop-string@^2.0.0
+```
 
+<a href="https://yarnpkg.com/package/crop-string"><img src="https://img.shields.io/badge/Yarn-crop--string-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="crop-string on Yarn"/></a>
 
+```bash
+yarn add crop-string@^2.0.0
+```
 
+<a href="https://github.com/jaid/crop-string/packages"><img src="https://img.shields.io/badge/GitHub Packages-@jaid/crop--string-24282e?style=flat-square&logo=github" alt="@jaid/crop-string on GitHub Packages"/></a>  
+(if [configured properly](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-npm-for-use-with-github-packages))
 
+```bash
+npm install --save @jaid/crop-string@^2.0.0
+```
 
 
 
+## Example
 
-## Installation
-<a href="https://npmjs.com/package/crop-string"><img src="https://img.shields.io/badge/npm-crop--string-C23039?style=flat-square&logo=npm" alt="crop-string on npm"/></a>
-```bash
-npm install --save crop-string@^2.0.0
-```
-<a href="https://yarnpkg.com/package/crop-string"><img src="https://img.shields.io/badge/Yarn-crop--string-2F8CB7?style=flat-square&logo=yarn&logoColor=white" alt="crop-string on Yarn"/></a>
-```bash
-yarn add crop-string@^2.0.0
+```javascript
+import cropString from "crop-string"
+
+const string = "hello world"
+const result = cropString(string, 4)
 ```
-<a href="https://jsdelivr.com/package/npm/crop-string/"><img src="https://img.shields.io/badge/jsDelivr-crop--string-orange?style=flat-square&logo=html5&logoColor=white" alt="crop-string on jsDelivr"/></a> <a href="https://unpkg.com/browse/crop-string/"><img src="https://img.shields.io/badge/UNPKG-crop--string-orange?style=flat-square&logo=html5&logoColor=white" alt="crop-string on UNPKG"/></a>
-```html
-<script src="https://cdn.jsdelivr.net/npm/crop-string@2.0.0/index.js"/>
+
+Variable `result` will now be:
+
+```javascript
+"hel…"
 ```
 
 
@@ -41,6 +55,12 @@ yarn add crop-string@^2.0.0
 
 
 
+
+
+
+
+
+
 ## Development