Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stadub committed Sep 9, 2019
1 parent d49b420 commit 246a229
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 29 deletions.
5 changes: 5 additions & 0 deletions 7Zip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,11 @@ Test-ZipFileContent - Perform zip file check

## Changelog

### [v1.1.0](https://github.com/stadub/PowershellScripts/releases/tag/v0.9.5)

* Fix Remove-ZipFileContent returns Cannot validate argument on parameter 'FileName'. #14
* Fix 7-zpi szc New-ZipFile alias is absent bug #14

### [v1.0.0](https://github.com/stadub/PowershellScripts/releases/tag/v0.4.0)

*First public release.
Expand Down
101 changes: 72 additions & 29 deletions Currency-Conv/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,40 @@
# Currency-Conv - Currecny converter

[![https://www.powershellgallery.com/packages/Currency-Conv/0.9.0](https://img.shields.io/badge/PowerShell%20Gallery-download-blue.svg?style=popout&logo=powershell)](https://www.powershellgallery.com/packages/Currency-Conv/0.9.0)

[![PowerShell 3](https://dev.azure.com/Stadub-Gh/PowershellScripts/_apis/build/status/Currency-Conv?branchName=master)](https://dev.azure.com/Stadub-Gh/PowershellScripts/_build/latest?definitionId=5&branchName=master)
[![PowerShell 4, 5 & Core on Windows build](https://ci.appveyor.com/api/projects/status/7tmg8wy30ipanjsd?svg=true)](https://ci.appveyor.com/project/stadub/powershellscripts)
[![Linux & MacOS build](https://img.shields.io/travis/stadub/PowershellScripts/master.svg?label=linux/macos+build)](https://travis-ci.org/stadub/PowershellScripts)
[![latest version](https://img.shields.io/powershellgallery/v/Currency-Conv.svg?label=latest+version)](https://www.powershellgallery.com/packages/Currency-Conv/)
[![downloads](https://img.shields.io/powershellgallery/dt/Currency-Conv.svg?label=downloads)](https://www.powershellgallery.com/packages/Currency-Conv)
<!-- [Documentation](https://powershellscripts.readthedocs.io/en/latest/) -->

---------------------

![ConsoleDemo](https://raw.githubusercontent.com/stadub/PowershellScripts/master/Currency-Conv/Assets/demo.gif)

## Instalation

Powershell Gallery:

[![https://www.powershellgallery.com/packages/Currency-Conv/](https://img.shields.io/badge/PowerShell%20Gallery-download-blue.svg?style=popout&logo=powershell)](https://www.powershellgallery.com/packages/Currency-Conv/)

`PowerShellGet` Installation :

```powershell
Install-Module -Name Currency-Conv
```

Direct download instalation:

```powershell
iex ('$module="Currency-Conv"'+(new-object net.webclient).DownloadString('https://raw.githubusercontent.com/stadub/PowershellScripts/master/install.ps1'))
```

Module import:

```powershell
Import-Module Currency-Conv
```

## Commands

```powershell
Expand All @@ -19,20 +46,35 @@ Get-ExchangeRate - Get exchange rate for amount
Get-Countries -Countries list with currencies
Get-Currencies - Supported currencies list
Remove-CurrencyApiKey- Clean key
```

## Aliases

| Cmdlet | Alias |
| -----------------|:--------:|
| Get-Currencies | gxc | xe |
| Cmdlet | Alias |
| -----------------|:-----:|
| Get-Currencies | gxc |
| Get-ExchangeRate | xe |

## Cache Timeouts

Default cache timeouts are stored in global variables so it can be changed to meet your needs.

Default values:

```powershell
$global:CurrencyConvExchangeRateCahcheLifetime = $([System.DateTimeOffset]::Now.AddSeconds(60.0))
$global:CurrencyConvCountriesCahcheLifetime = $([System.DateTimeOffset]::Now.AddHours(15.0))
$global:CurrencyConvCurrenciesCahcheLifetime = $([System.DateTimeOffset]::Now.AddHours(15.0))
```

## Usage

Currency exchange rates:

```powershell
/> Get-ExchangeRate USD BYN 5
/> Get-ExchangeRate All BDD 5
```

```powershell
Expand Down Expand Up @@ -63,29 +105,24 @@ List supported currencies:
/> Get-Currencies
```

## Changelog

### [v0.9.0](https://github.com/stadub/PowershellScripts/releases/tag/v0.8.2) May 17, 2019

* Add demo gif and documentation

### [v0.8.5](https://github.com/stadub/PowershellScripts/releases/tag/v0.8.0)
Remove currconv.com api key fromthe system:

* Move module to individual foler.
* Create Markdown page.

### [v0.8.1](https://github.com/stadub/PowershellScripts/releases/tag/v0.2.0)
```powershell
/> Remove-CurrencyApiKey
```

* Separate functions and aliases.
## Changelog

### [v0.8.0](https://github.com/stadub/PowershellScripts/releases/tag/v0.1.0)
### [v1.5.0](https://github.com/stadub/PowershellScripts/releases/tag/v0.9.5) Spet 9, 2019

* Add module methods description.
* Add Request cache #12
* Add ability to change cache timeount #12

* Rename `Remove-CurrencyApi-Key` to `Remove-CurrencyApiKey` to be ps1 cmdlet name restrictions compliant

### [v0.7.0](https://github.com/stadub/PowershellScripts/releases/tag/v0.1.0) Mar 18, 2019
### [v1.0.2](https://github.com/stadub/PowershellScripts/releases/tag/v0.9.0) Spet 1, 2019

* Added exchange convertion functions:
* Add functions:

```powershell
Get-ExchangeRate - Get exchange rate for amount
Expand All @@ -97,19 +134,25 @@ Get-Countries -Countries list with currencies
Get-Currencies - Supported currencies list
Remove-CurrencyApi-Key- Clean key
```

* Create tests

## Motivation

Hi, I written this module(and other modules of the repo) for my own usage.
But if you found it usefull you can Buy me a beer/cup of tee😊
The modules are created and actively maintained during evenings and weekends for my own needs.
If it's useful for you too, that's great. I don't demand anything in return.

<!-- By Paypal [![PayPal.me](https://img.shields.io/badge/PayPal-me-blue.svg?maxAge=2592000)](https://www.paypal.me/dima.by)
However, if you like it and feel the urge to give something back,
a coffee or a beer is always appreciated. Thank you very much in advance.

<> Or
[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/dima)
[![Support by Yandex](https://raw.githubusercontent.com/GitStatic/Resources/master/yaMoney.png)](https://money.yandex.ru/to/410014572567962/200)

<!-- By Paypal [![PayPal.me](https://img.shields.io/badge/PayPal-me-blue.svg?maxAge=2592000)](https://www.paypal.me/dima.by)
-->
[![Yandex Money](https://money.yandex.ru/i/ym2015_icon.png)](https://money.yandex.ru/to/410014572567962)

<!-- Yandex Money (https://money.yandex.ru/i/ym2015_icon.png)(https://money.yandex.ru/to/410014572567962) -->
If you have any idea or suggestion - please add a github issue.

If you have any idea or suggestion - please add a github issue and I'll try to implement it😉
<!-- https://www.contributor-covenant.org/version/1/4/code-of-conduct -->

0 comments on commit 246a229

Please sign in to comment.