chore: Add basic example to the documentation

GoToolSharing · Jun 14, 2024 · b455080 · b455080
1 parent 77570e8
commit b455080
Show file tree

Hide file tree

Showing 11 changed files with 156 additions and 8 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -35,6 +35,7 @@ export default defineConfig({
         collapsed: true,
 	items: [
           { text: 'Home', link: '/getting-started/home' },
+          { text: 'Installation', link: '/getting-started/installation' },
           { text: 'Company', link: '/getting-started/company' },
         ]
       },
@@ -50,6 +51,7 @@ export default defineConfig({
           { text: '--year-separators', link: '/company/year-separators' },
           { text: '--mixed-case', link: '/company/mixed-case' },
           { text: '--year', link: '/company/year' },
+          { text: '--all', link: '/company/all' },
         ]
       }
     ],

diff --git a/docs/company/all.md b/docs/company/all.md
@@ -0,0 +1,18 @@
+# All
+
+```bash
+> passfinder company -n passfinder --all
+
+[...]
+PASSFINdEr!2024?
+PASSFINdEr!2024=
+PASSFINdEr!2024*
+PASSFINdEr@2024!
+PASSFINdEr@2024@
+PASSFINdEr@2024#
+PASSFINdEr@2024$
+PASSFINdEr@2024%
+PASSFINdEr@2024+
+PASSFINdEr@2024?
+[...]
+```
diff --git a/docs/company/end-special.md b/docs/company/end-special.md
@@ -1 +1,15 @@
-# end-special
+# end-special
+
+```bash
+> passfinder company -n passfinder --end-special
+
+passfinder
+passfinder!
+passfinder@
+passfinder#
+passfinder$
+passfinder%
+passfinder+
+passfinder?
+passfinder=
+```
diff --git a/docs/company/leet.md b/docs/company/leet.md
@@ -1 +1,18 @@
-# leet
+# leet
+
+```bash
+> passfinder company -n passfinder --leet
+
+[...]
+p@5$f!nder
+p@5$find3r
+p@5$finder
+p@5sf1nd3r
+p@5sf1nder
+p@5sf!nd3r
+p@5sf!nder
+p@5sfind3r
+p@5sfinder
+p@$5f1nd3r
+[...]
+```
diff --git a/docs/company/mask.md b/docs/company/mask.md
@@ -1 +1,18 @@
-# mask
+# mask
+
+```bash
+> passfinder company -n passfinder --mask "%w202%d%s"
+
+[...]
+passfinder2027<
+passfinder2027>
+passfinder2027?
+passfinder2027/
+passfinder2027\
+passfinder2028!
+passfinder2028@
+passfinder2028#
+passfinder2028$
+passfinder2028%
+[...]
+```
diff --git a/docs/company/mixed-case.md b/docs/company/mixed-case.md
@@ -1 +1,17 @@
-# mixed-case
+# mixed-case
+
+```bash
+> passfinder company -n passfinder --mixed-case
+
+PAssFINDER
+PAsSfinder
+PAsSfindeR
+PAsSfindEr
+PAsSfindER
+PAsSfinDer
+PAsSfinDeR
+PAsSfinDEr
+PAsSfinDER
+PAsSfiNder
+[...]
+```
diff --git a/docs/company/short-year.md b/docs/company/short-year.md
@@ -1 +1,8 @@
-# short-year
+# short-year
+
+```bash
+> passfinder company -n passfinder --short-year
+
+passfinder
+passfinder24
+```
diff --git a/docs/company/start-caps.md b/docs/company/start-caps.md
@@ -1 +1,8 @@
-# start-caps
+# start-caps
+
+```bash
+> passfinder company -n passfinder --start-caps
+
+passfinder
+Passfinder
+```
diff --git a/docs/company/year-separators.md b/docs/company/year-separators.md
@@ -1 +1,32 @@
-# year-separators
+# year-separators
+
+```bash
+> passfinder company -n passfinder --year --year-separators
+
+passfinder
+passfinder2024
+passfinder!2024
+passfinder@2024
+passfinder#2024
+passfinder$2024
+passfinder%2024
+passfinder+2024
+passfinder?2024
+passfinder=2024
+```
+
+```bash
+> passfinder company -n passfinder --short-year --year-separators
+
+passfinder
+passfinder24
+passfinder!24
+passfinder@24
+passfinder#24
+passfinder$24
+passfinder%24
+passfinder+24
+passfinder?24
+passfinder=24
+passfinder*24
+```
diff --git a/docs/company/year.md b/docs/company/year.md
@@ -1 +1,7 @@
-# year
+# year
+
+```bash
+> passfinder company -n passfinder --year
+
+passfinder2024
+```
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -0,0 +1,13 @@
+# Installation
+
+## Stable
+
+```bash
+go install https://github.com/GoToolSharing/passfinder
+```
+
+## Dev
+
+```bash
+go install https://github.com/GoToolSharing/passfinder@dev
+```