Update monorepo readme

blakeembrey · Sep 29, 2023 · 012c78a · 012c78a
1 parent be1bf58
commit 012c78a
Show file tree

Hide file tree

Showing 2 changed files with 120 additions and 266 deletions.
diff --git a/README.md b/README.md
@@ -1,258 +1,15 @@
-# Change Case
+# Change Case Monorepo
 
 > Transform a string between `camelCase`, `PascalCase`, `Capital Case`, `snake_case`, `param-case`, `CONSTANT_CASE` and others.
 
-## Installation
+## Packages
 
-```
-npm install change-case --save
-```
-
-## Usage
-
-```js
-import * as changeCase from "change-case";
-```
-
-### Core
-
-These functions come bundled with [`change-case`](https://github.com/blakeembrey/change-case/tree/master/packages/change-case):
-
-- [`camelCase`](#camelcase)
-- [`capitalCase`](#capitalcase)
-- [`constantCase`](#constantcase)
-- [`dotCase`](#dotcase)
-- [`headerCase`](#headercase)
-- [`noCase`](#nocase)
-- [`paramCase`](#paramcase)
-- [`pascalCase`](#pascalcase)
-- [`pathCase`](#pathcase)
-- [`sentenceCase`](#sentencecase)
-- [`snakeCase`](#snakecase)
-
-All core methods accept [`options`](#options) as the second argument.
-
-#### [camelCase](https://github.com/blakeembrey/change-case/tree/master/packages/camel-case)
-
-> Transform into a string with the separator denoted by the next word capitalized.
-
-```js
-camelCase("test string");
-//=> "testString"
-```
-
-#### [capitalCase](https://github.com/blakeembrey/change-case/tree/master/packages/capital-case)
-
-> Transform into a space separated string with each word capitalized.
-
-```js
-capitalCase("test string");
-//=> "Test String"
-```
-
-#### [constantCase](https://github.com/blakeembrey/change-case/tree/master/packages/constant-case)
-
-> Transform into upper case string with an underscore between words.
-
-```js
-constantCase("test string");
-//=> "TEST_STRING"
-```
-
-#### [dotCase](https://github.com/blakeembrey/change-case/tree/master/packages/dot-case)
-
-> Transform into a lower case string with a period between words.
-
-```js
-dotCase("test string");
-//=> "test.string"
-```
-
-#### [headerCase](https://github.com/blakeembrey/change-case/tree/master/packages/header-case)
-
-> Transform into a dash separated string of capitalized words.
-
-```js
-headerCase("test string");
-//=> "Test-String"
-```
-
-#### [noCase](https://github.com/blakeembrey/change-case/tree/master/packages/no-case)
-
-> Transform into a lower cased string with spaces between words.
-
-```js
-noCase("testString");
-//=> "test string"
-```
-
-#### [paramCase](https://github.com/blakeembrey/change-case/tree/master/packages/param-case)
-
-> Transform into a lower cased string with dashes between words.
-
-```js
-paramCase("test string");
-//=> "test-string"
-```
-
-#### [pascalCase](https://github.com/blakeembrey/change-case/tree/master/packages/pascal-case)
-
-> Transform into a string of capitalized words without separators.
-
-```js
-pascalCase("test string");
-//=> "TestString"
-```
-
-#### [pathCase](https://github.com/blakeembrey/change-case/tree/master/packages/path-case)
-
-> Transform into a lower case string with slashes between words.
-
-```js
-pathCase("test string");
-//=> "test/string"
-```
-
-#### [sentenceCase](https://github.com/blakeembrey/change-case/tree/master/packages/sentence-case)
-
-> Transform into a lower case with spaces between words, then capitalize the string.
-
-```js
-sentenceCase("testString");
-//=> "Test string"
-```
-
-#### [snakeCase](https://github.com/blakeembrey/change-case/tree/master/packages/snake-case)
-
-> Transform into a lower case string with underscores between words.
-
-```js
-snakeCase("test string");
-//=> "test_string"
-```
-
-### Other Case Utilities
-
-- [`titleCase`](#titlecase)
-- [`swapCase`](#swapcase)
-- [`isLowerCase`](#islowercase)
-- [`isUpperCase`](#isuppercase)
-- [`lowerCase`](#lowercase)
-- [`lowerCaseFirst`](#lowercasefirst)
-- [`upperCase`](#uppercase)
-- [`upperCaseFirst`](#uppercasefirst)
-- [`spongeCase`](#spongeCase)
-
-_These functions are not "case" libraries but independent functions, you must install these separately._
-
-#### [titleCase](https://github.com/blakeembrey/change-case/tree/master/packages/title-case)
-
-> Transform a string into title case following English rules.
-
-```js
-titleCase("a simple test");
-//=> "A Simple Test"
-```
-
-#### [swapCase](https://github.com/blakeembrey/change-case/tree/master/packages/swap-case)
-
-> Transform a string by swapping every character from upper to lower case, or lower to upper case.
-
-```js
-swapCase("Test String");
-//=> "tEST sTRING"
-```
-
-#### [isLowerCase](https://github.com/blakeembrey/change-case/tree/master/packages/is-lower-case)
-
-> Returns `true` if the string is lower case only.
-
-```js
-isLowerCase("test string");
-//=> true
-```
-
-#### [isUpperCase](https://github.com/blakeembrey/change-case/tree/master/packages/is-upper-case)
-
-> Returns `true` if the string is upper case only.
-
-```js
-isUpperCase("test string");
-//=> false
-```
-
-#### [lowerCase](https://github.com/blakeembrey/change-case/tree/master/packages/lower-case)
-
-> Transforms the string to lower case.
-
-```js
-lowerCase("TEST STRING");
-//=> "test string"
-```
-
-#### [lowerCaseFirst](https://github.com/blakeembrey/change-case/tree/master/packages/lower-case-first)
-
-> Transforms the string with the first character in lower cased.
-
-```js
-lowerCaseFirst("TEST");
-//=> "tEST"
-```
-
-#### [upperCase](https://github.com/blakeembrey/change-case/tree/master/packages/upper-case)
-
-> Transforms the string to upper case.
-
-```js
-upperCase("test string");
-//=> "TEST STRING"
-```
-
-#### [upperCaseFirst](https://github.com/blakeembrey/change-case/tree/master/packages/upper-case-first)
-
-> Transforms the string with the first character in upper cased.
-
-```js
-upperCaseFirst("test");
-//=> "Test"
-```
-
-#### [spongeCase](https://github.com/blakeembrey/change-case/tree/master/packages/sponge-case)
-
-> Transform into a string with random capitalization applied.
-
-```js
-spongeCase("Test String");
-//=> "tEst stRINg"
-```
-
-### Options
-
-- **`splitRegexp`** RegExp used to split into word segments (see [example](#split-example)).
-- **`stripRegexp`** RegExp used to remove extraneous characters (default: `/[^A-Z0-9]/gi`).
-- **`delimiter`** Value used between words (e.g. `" "`).
-- **`transform`** Used to transform each word segment (e.g. `lowerCase`).
-
-#### Split Example
-
-If you find the default split hard to use, you can provide a different one. The example below will change the behavior to `word2019 -> word 2019` and `minifyURLs -> minify urls`:
-
-```js
-const options = {
-  splitRegexp: /([a-z])([A-Z0-9])/g,
-};
-```
-
-To support non-ASCII characters, you can use the "letter" character category matcher `\p{L}` together with `/u` Unicode support flag.
-For lowercase `\p{Ll}`, uppercase `\p{Lu}`.
-
-Above regex modified:
-
-```js
-splitRegexp: /([\p{Ll})([\p{Lu}\d])/gu,
-```
-
-See https://www.regular-expressions.info/unicode.html (Unicode Categories section) for more.
+- [change-case](https://github.com/blakeembrey/change-case/tree/master/packages/change-case)
+- [sponge-case](https://github.com/blakeembrey/change-case/tree/master/packages/sponge-case)
+- [swap-case](https://github.com/blakeembrey/change-case/tree/master/packages/swap-case)
+- [title-case](https://github.com/blakeembrey/change-case/tree/master/packages/title-case)
+- [lower-case-first](https://github.com/blakeembrey/change-case/tree/master/packages/lower-case-first)
+- [upper-case-first](https://github.com/blakeembrey/change-case/tree/master/packages/upper-case-first)
 
 ## Related