diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 67 |
1 files changed, 36 insertions, 31 deletions
@@ -1,52 +1,57 @@ -[![MELPA][melpa-badge]][melpa-package] -[![MELPA Stable][melpa-stable-badge]][melpa-stable-package] -[![Gitter][gitter-badge]][gitter-chatroom] -[![Build Status][travis-ci-badge]][travis-ci-status] - # wttrin.el -Emacs frontend for weather web service [wttr.in]. +Emacs frontend for weather web service [wttr.in](https://wttr.in). + +This fork has a few minor improvements: +- It displays the date and time the weather was displayed. +- It allows for customizing the font and font height used to display. +- On location re-query, the original weather buffer is closed, reducing buffer clutter. +- The license has changed from the MIT license to the GNU General Public License Version 3. + +In addition, this fork applies the following patches (outstanding in bcbcarl/emacs-wttrin): +- [patch to selecting the unit system](https://github.com/bcbcarl/emacs-wttrin/pull/10) +- [patch to request the return ascii instead of html](https://github.com/bcbcarl/emacs-wttrin/pull/18) +- [patch to use https instead of http](https://github.com/bcbcarl/emacs-wttrin/pull/15) + +All changes have been tested and are working as of Monday, April 01, 2024. -This fork has the following patches applied (still outstanding in bcbcarl/emacs-wttrin): -- patch for selecting the unit system: https://github.com/bcbcarl/emacs-wttrin/pull/10 -- patch for url request to return ascii rather than html https://github.com/bcbcarl/emacs-wttrin/pull/18 -- patch to use https instead of http: https://github.com/bcbcarl/emacs-wttrin/pull/15 +Bug reports and PRs are welcome. + +Enjoy! ## Usage Set a default cities list for completion: ```elisp -(setq wttrin-default-cities '("Taipei" "Tainan")) -``` +(setq wttrin-default-cities '( "Berkeley, California" "Taipei, Taiwan" "Tainan, Taiwan"))``` You can also specify default HTTP request Header for Accept-Language: ```elisp -(setq wttrin-default-accept-language '("Accept-Language" . "zh-TW")) -``` +(setq wttrin-default-accept-language '("Accept-Language" . "zh-TW")))``` + As well as the unit system, "m" for metric and "u" for USCS/imperial (the default is to choose based on your location): ```elisp -(setq wttrin-unit-system "m") -``` -Then run `M-x wttrin` to get the information. +(setq wttrin-unit-system "m")``` + +If you want the weather to display in a monospaced font other than your default, you may specify it: + +```elisp +(setq wttrin-font-name "Hack Nerd Font Mono")``` + +You can specify the font height as well: + +```elisp +(setq wttrin-font-name "Liberation Mono")``` + +Then run `M-x wttrin` to display the weather. -When the weather is displayed you can press `q` to quit the buffer or `g` to query for another city. +After the weather is displayed you may press `q` to quit the buffer or `g` to query the weather for another location. -![screenshot] + ## LICENSE -MIT - -[wttr.in]: http://wttr.in/ -[screenshot]: wttrin.png -[melpa-badge]: http://melpa.org/packages/wttrin-badge.svg -[melpa-package]: http://melpa.org/#/wttrin -[melpa-stable-badge]: http://stable.melpa.org/packages/wttrin-badge.svg -[melpa-stable-package]: http://stable.melpa.org/#/wttrin -[gitter-badge]: https://badges.gitter.im/bcbcarl/emacs-wttrin.svg -[gitter-chatroom]: https://gitter.im/bcbcarl/emacs-wttrin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge -[travis-ci-badge]: https://travis-ci.org/bcbcarl/emacs-wttrin.svg?branch=master -[travis-ci-status]: https://travis-ci.org/bcbcarl/emacs-wttrin +GPL-v3 |