sandy
/
mop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
master
Brandon Lee Camilleri 3 years ago committed by GitHub
parent ce14954fe6
commit 6a716bb30b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 37 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 46
      README.md

46
README.md
Unescape View File

@ -1,8 +1,5 @@
### Mop: track stocks the hacker way ### ### Mop: track stocks the hacker way ###
Mop is a command-line utility that displays continuous up-to-date information about the U.S. markets and individual stocks.
Mop is a command-line utility that displays continuous up-to-date
information about the U.S. markets and individual stocks. One
screenshot is worth a thousand words:
![Screenshot](https://raw.githubusercontent.com/mop-tracker/mop/master/doc/screenshot.png "Mop Screenshot") ![Screenshot](https://raw.githubusercontent.com/mop-tracker/mop/master/doc/screenshot.png "Mop Screenshot")
@ -21,9 +18,7 @@ Alternatively,
$ ./mop $ ./mop
### Using Mop ### ### Using Mop ###
For demonstration purposes Mop comes preconfigured with a number of For demonstration purposes Mop comes preconfigured with a number of stock tickers. You can easily change the default list by using the following keyboard commands:
stock tickers. You can easily change the default list by using the
following keyboard commands:
+ Add stocks to the list. + Add stocks to the list.
- Remove stocks from the list. - Remove stocks from the list.
@ -34,8 +29,7 @@ following keyboard commands:
? Display help screen. ? Display help screen.
esc Quit mop. esc Quit mop.
When prompted please enter comma-delimited list of stock tickers. The When prompted please enter comma-delimited list of stock tickers. The list and other settings are stored in the profile file (default: ``.moprc`` in your ``$HOME`` directory)
list and other settings are stored in the profile file (default: ``.moprc`` in your ``$HOME`` directory)
### Expression-based Filtering ### Expression-based Filtering
Mop has an in realtime expression-based filtering engine that is very easy to use. Mop has an in realtime expression-based filtering engine that is very easy to use.
@ -59,37 +53,15 @@ To clear the filter, press `Shift+F`.
You can specify the profile you want to use by passing ``-profile <filename>`` to the command-line. You can specify the profile you want to use by passing ``-profile <filename>`` to the command-line.
### Contributing ### ### Contributing ###
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/michaeldv/mop?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Mop is my personal project I came up with to learn Go programming. Your
comments, suggestions, and contributions are welcome.
* Fork the project on Github.
* Make your feature addition or bug fix.
* Pull requests accepted. * Pull requests accepted.
* Commit, do not change program version, or commit history. * Commit without changing program version or commit history.
### License ### ### License ###
Copyright (c) 2013-2019 by Michael Dvorkin and contributors. All Rights Reserved. Copyright (c) 2013-2019 by Michael Dvorkin and contributors. All Rights Reserved.
"mike" + "@dvorkin" + ".net" || "twitter.com/mid" "mike" + "@dvorkin" + ".net" || "twitter.com/mid"
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Write Preview
Loading…
Cancel
Save