mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-06-17 00:07:37 +02:00
doc update
This commit is contained in:
@ -7,7 +7,7 @@ jc - JSON Convert Email Address string parser
|
||||
|
||||
Usage (cli):
|
||||
|
||||
$ echo "johndoe@example.com" | jc --email-address
|
||||
$ echo "username@example.com" | jc --email-address
|
||||
|
||||
Usage (module):
|
||||
|
||||
@ -17,9 +17,9 @@ Usage (module):
|
||||
Schema:
|
||||
|
||||
{
|
||||
"username": string,
|
||||
"domain": string,
|
||||
"local": string,
|
||||
"local_plus_prefix": string or null,
|
||||
"local_plus_suffix": string or null
|
||||
}
|
||||
|
||||
@ -27,17 +27,17 @@ Examples:
|
||||
|
||||
$ echo 'joe.user@gmail.com' | jc --email-address -p
|
||||
{
|
||||
"username": "joe.user",
|
||||
"domain": "gmail.com",
|
||||
"local": "joe.user",
|
||||
"local_plus_prefix": null,
|
||||
"local_plus_suffix": null
|
||||
}
|
||||
|
||||
$ echo 'joe.user+spam@gmail.com' | jc --email-address -p
|
||||
{
|
||||
"username": "joe.user",
|
||||
"domain": "gmail.com",
|
||||
"local": "joe.user+spam",
|
||||
"local_plus_prefix": "joe.user",
|
||||
"local_plus_suffix": "spam"
|
||||
}
|
||||
|
||||
|
@ -32,7 +32,7 @@ Schema:
|
||||
|
||||
{
|
||||
"url": string,
|
||||
"scheme": string,
|
||||
"scheme": string or null,
|
||||
"netloc": string or null,
|
||||
"path": string or null,
|
||||
"path_list": [ array or null
|
||||
@ -51,7 +51,7 @@ Schema:
|
||||
"port": integer or null, # [1]
|
||||
"encoded": {
|
||||
"url": string,
|
||||
"scheme": string,
|
||||
"scheme": string or null,
|
||||
"netloc": string or null,
|
||||
"path": string or null,
|
||||
"path_list": [ array or null
|
||||
@ -66,7 +66,7 @@ Schema:
|
||||
},
|
||||
"decoded": {
|
||||
"url": string,
|
||||
"scheme": string,
|
||||
"scheme": string or null,
|
||||
"netloc": string or null,
|
||||
"path": string or null,
|
||||
"path_list": [ array or null
|
||||
|
Reference in New Issue
Block a user