github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Update Grammer/Spelling in README.md (#642)

pull/644/head
Anders Øen Fylling 2022-08-09 19:28:25 +02:00 committed by GitHub
parent e6380b96e2
commit 1816c448ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -186,7 +186,7 @@ You can also check out the [Graphical version of Apprise](https://github.com/car
# Command Line Usage # Command Line Usage
A small command line interface (CLI) tool is also provided with this package called *apprise*. If you know the server url's you wish to notify, you can simply provide them all on the command line and send your notifications that way: A small command line interface (CLI) tool is also provided with this package called *apprise*. If you know the server urls you wish to notify, you can simply provide them all on the command line and send your notifications that way:
```bash ```bash
# Send a notification to as many servers as you want # Send a notification to as many servers as you want
# as you can easily chain one after another (the -vv provides some # as you can easily chain one after another (the -vv provides some
@ -373,12 +373,12 @@ apobj.notify(
tag='admin', tag='admin',
) )
# If you want to notify absolutely everything (reguardless of whether # If you want to notify absolutely everything (regardless of whether
# it's been tagged or not), just use the reserved tag of 'all': # it's been tagged or not), just use the reserved tag of 'all':
apobj.notify( apobj.notify(
body='send a notification to our admin group', body='send a notification to our admin group',
title='Attention Admins', title='Attention Admins',
# notify absolutely everything loaded, reguardless on wether # notify absolutely everything loaded, regardless on wether
# it has a tag associated with it or not: # it has a tag associated with it or not:
tag='all', tag='all',
) )
@ -405,8 +405,8 @@ apobj.notify(
# Send a web based attachment too! In the below example, we connect to a home # Send a web based attachment too! In the below example, we connect to a home
# security camera and send a live image to an email. By default remote web # security camera and send a live image to an email. By default remote web
# content is cached but for a security camera, we might want to call notify # content is cached, but for a security camera we might want to call notify
# again later in our code so we want our last image retrieved to expire(in # again later in our code, so we want our last image retrieved to expire(in
# this case after 3 seconds). # this case after 3 seconds).
apobj.notify( apobj.notify(
title='Latest security image', title='Latest security image',
@ -424,7 +424,7 @@ apobj = apprise.Apprise()
# Add at least one service you want to notify # Add at least one service you want to notify
apobj.add('mailto://myuser:mypass@hotmail.com') apobj.add('mailto://myuser:mypass@hotmail.com')
# Now add all of the entries we're intrested in: # Now add all of the entries we're interested in:
attach = ( attach = (
# ?name= allows us to rename the actual jpeg as found on the site # ?name= allows us to rename the actual jpeg as found on the site
# to be another name when sent to our receipient(s) # to be another name when sent to our receipient(s)
@ -475,6 +475,7 @@ asset = AppriseAsset(
# absolute .py file. Hence, there is no (level 1) scanning at all # absolute .py file. Hence, there is no (level 1) scanning at all
# within the directory specified. # within the directory specified.
"/path/to/dir/library" "/path/to/dir/library"
]
) )
# Now that we've got our asset, we just work with our Apprise object as we # Now that we've got our asset, we just work with our Apprise object as we