Skip to content

Commit

Permalink
docs: add demo links to recipes.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arjunvegda committed Feb 21, 2022
1 parent 59fc694 commit 592f64f
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
<a href="https://codecov.io/gh/arjunvegda/japanese-moji">
<img src="https://codecov.io/gh/arjunvegda/japanese-moji/branch/main/graph/badge.svg?token=GZ8GBUVYD8"/>
</a>
<a href="https://japanese-moji.vercel.app">
<img src="https://img.shields.io/badge/website-%F0%9F%8C%8E-green" alt="Website" />
</a>
<a href="./LICENSE">
<img src="https://badgen.net/npm/license/japanese-moji?color=blue"/>
</a>
Expand All @@ -29,7 +32,6 @@ The word "Moji" translates to "Character" in English
**Table of Contents**

- [Features](#-features)
- [Demo](#-demo)
- [Install](#-install)
- [Quick start](#-quick-start)
- [Kanji](#kanji)
Expand All @@ -53,10 +55,6 @@ The word "Moji" translates to "Character" in English
- ESM, CJS, and UMD builds
- Only pay for what you use — its fully tree-shakable

## 🚀 Demo

Live demos are on this [website](https://japanese-moji.vercel.app)

## 📦 Install

### Yarn
Expand All @@ -75,7 +73,9 @@ npm install --save japanese-moji

### Kanji

Validates Rare Kanji, Common and Uncommon Kanji, and Kanji compatibility ideographs
Validates Rare Kanji, Common and Uncommon Kanji, and Kanji compatibility ideographs <br/><br/>
<a href="https://japanese-moji.vercel.app/demos#kanji">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" /> </a>

```ts
import { isValidKanji, isKanjiPresent, howMuchKanjiIsPresent } from 'japanese-moji';
Expand All @@ -92,7 +92,9 @@ const howMuchKanjiIsPresentResult = howMuchKanjiIsPresent('some string here');

### Kana

Validates Katakana, Half-width Katakana, and Katakana phonetic extensions
Validates Katakana, Half-width Katakana, and Katakana phonetic extensions <br/><br/>
<a href="https://japanese-moji.vercel.app/demos#kana">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" /> </a>

```ts
import { isValidKana, isKanaPresent, howMuchKanaIsPresent } from 'japanese-moji';
Expand All @@ -111,7 +113,8 @@ const howMuchKanaIsPresentResult = howMuchKanaIsPresent('some string here');

Validates CJK punctuations, Hiragana, Katakana, Katakana phonetic extensions, Rare Kanji, Common and
Uncommon Kanji, Kanji compatibility ideographs, Half-width Katakana forms, and Full-width (roman)
forms including punctuations
forms including punctuations <br/><br/> <a href="https://japanese-moji.vercel.app/demos#japanese">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" /> </a>

```ts
import { isValidJapanese, isJapanesePresent, howMuchJapaneseIsPresent } from 'japanese-moji';
Expand Down Expand Up @@ -228,7 +231,9 @@ const howMuchIsCustomPresentResult = howMuchIsCustomPresent('some string here');
## 📚 Recipes

Find code snippets containing variety of combinations that makes creating custom validators easy in
[docs/RECIPES.md](./docs/RECIPES.md)
[docs/RECIPES.md](./docs/RECIPES.md) <br/><br/>
<a href="https://japanese-moji.vercel.app/demos#custom-recipes">
<img src="https://img.shields.io/badge/demos-%F0%9F%9A%80-green" alt="Demo" /> </a>

## 🙌 Contributing

Expand Down
29 changes: 29 additions & 0 deletions docs/RECIPES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# 📚 Recipes

<a href="https://japanese-moji.vercel.app/demos#custom-recipes">
<img src="https://img.shields.io/badge/demos-%F0%9F%9A%80-green" alt="Demo" />
</a>
<br/>

A collection of code snippets to make creating
[custom validators](../README.md#-build-your-own-validators) easy. These recipes could be supplied
to create custom validators. [Kana](../README.md#kana), [Kanji](../README.md#kanji) and
Expand Down Expand Up @@ -43,6 +48,10 @@ const howMuchIsCustomPresent: MatchScoreCalculator = createMatchScoreCalculator(

## Hiragana

<a href="https://japanese-moji.vercel.app/demos#hiragana">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" />
</a>

```ts
const options: CreateValidatorOptions = {
characterSets: [CharacterSet.Hiragana],
Expand All @@ -51,6 +60,10 @@ const options: CreateValidatorOptions = {

## Hiragana + CJK Symbols & Punctuations

<a href="https://japanese-moji.vercel.app/demos#hiragana-cjk-punctuations">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" />
</a>

```ts
const options: CreateValidatorOptions = {
characterSets: [CharacterSet.Hiragana, CharacterSet.CJKPunctuations],
Expand All @@ -59,6 +72,10 @@ const options: CreateValidatorOptions = {

## Hiragana + All Katakana

<a href="https://japanese-moji.vercel.app/demos#hiragana-katakana">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" />
</a>

```ts
const options: CreateValidatorOptions = {
characterSets: [
Expand All @@ -72,6 +89,10 @@ const options: CreateValidatorOptions = {

## Hiragana + All Kanji

<a href="https://japanese-moji.vercel.app/demos#hiragana-kanji">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" />
</a>

```ts
const options: CreateValidatorOptions = {
characterSets: [
Expand All @@ -85,6 +106,10 @@ const options: CreateValidatorOptions = {

## All fullwidth letters

<a href="https://japanese-moji.vercel.app/demos#fullwidth-letters">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" />
</a>

```ts
const options: CreateValidatorOptions = {
characterSets: [
Expand All @@ -98,6 +123,10 @@ const options: CreateValidatorOptions = {

## Latin punctuations + All Japanese

<a href="https://japanese-moji.vercel.app/demos#latin-punctuations-japanese">
<img src="https://img.shields.io/badge/demo-%F0%9F%9A%80-green" alt="Demo" />
</a>

```ts
// includes: " " (space), !"#$%&'()*+,-./
const LatinPunctuations: UnicodeRange = {
Expand Down

0 comments on commit 592f64f

Please sign in to comment.