Skip to content

Commit 6855b55

Browse files
authored
docs: List all notations in README.md
1 parent 838376a commit 6855b55

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,28 @@ _Convert between different string notations commonly found in programming._
33
Useful, for example, to build identifiers when generating code.
44
Also includes notations to build valid Java type or member names.
55

6-
[API Documentation](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/)
6+
#### [API Documentation](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/)
7+
8+
## Notations
9+
We support the following notations:
10+
11+
* General Programming
12+
* [LowerCamelCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-lower-camel-case/), e.g. `thisIsMyString`
13+
* [UpperCamelCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-upper-camel-case/), e.g. `ThisIsMyString`
14+
* [SnakeCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-snake-case/), e.g. `this_is_MY_String`
15+
* [ScreamingSnakeCase](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-screaming-snake-case/), e.g. `THIS_IS_MY_STRING`
16+
* Java
17+
* [JavaMemberName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-member-name/), e.g. `thisIsMyString`
18+
* [JavaTypeName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-type-name/), e.g. `ThisIsMyString`
19+
* [JavaConstantName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-constant-name/), e.g. `THIS_IS_MY_STRING`
20+
* [JavaPackageName](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-package-name/), e.g. `this.is.MY.String`
21+
* [JavaPackagePart](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-java-package-part/), e.g. `thisismystring`
22+
* Miscellaneous
23+
* [NormalWords](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-normal-words/), e.g. `this is MY String`
724

825
## Usage
9-
`string-notation` converts Strings from their notation into a [Word](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-word), which is a notation-agnostic representation.
10-
[Words](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-word) can then be transformed into Strings in a notation again.
26+
`string-notation` converts Strings from their notation into a [Word](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-word/), which is a notation-agnostic representation.
27+
[Words](https://jgleitz.github.io/string-notation/string-notation/de.joshuagleitze.stringnotation/-word/) can then be transformed into Strings in a notation again.
1128

1229
### Kotlin
1330

0 commit comments

Comments
 (0)