Skip to content

Commit f0e80e1

Browse files
committed
📝 update documentation
On branch main Changes to be committed: modified: README.md modified: docs/README.md
1 parent baf6960 commit f0e80e1

File tree

2 files changed

+20
-31
lines changed

2 files changed

+20
-31
lines changed

README.md

+12-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
11
<h1 align="center">SimpleMaskMoney</h1>
22

3-
<h3 align="center">⚠️<b>WARNING</b>⚠️</h3>
4-
53
<h5 align="center">
4+
⚠️<b>WARNING</b>⚠️<br>
65
If you are having problems please check the version that you are using. <br>
7-
This package follows the <a>semantic versioning</a> try to keep it updated with the <a href="">latest version</a>.
6+
This package follows the <a href="https://semver.org/">semantic versioning</a> try to keep it updated with the <a href="https://github.com/codermarcos/simple-mask-money">latest version</a>.
87
</h5>
98

10-
<p align="center">
11-
<a class="badge-align" href="https://nodei.co/npm/simple-mask-money/">
12-
<img src="https://nodei.co/npm/simple-mask-money.png?downloads=true&downloadRank=true" alt="NPM"></a>
13-
</p>
14-
159
<p align="center">
1610
<a class="badge-align" href="https://github.com/codermarcos/simple-mask-money/actions/workflows/on_push.yaml">
1711
<img src="https://github.com/codermarcos/simple-mask-money/actions/workflows/on_push.yaml/badge.svg?event=push" alt="build status"/>
@@ -27,10 +21,7 @@
2721
</a>
2822
</p>
2923

30-
<p align="center">
31-
Simple money mask developed with pure JavaScript 🗃️ <b>0 dependecies</b>, 🔒 <b>100% Safe</b> (no <a href="https://docs.npmjs.com/auditing-package-dependencies-for-security-vulnerabilities">npm audit problems as vulnerabilities</a> or <a href="https://github.com/codermarcos/simple-mask-money/security/dependabot">dependabot issues</a>) which you can run on <b>Client Side</b> and <b>Server Side</b>.
32-
<a href="https://simple-mask-money.codermarcos.zone/">Try <b>live demo</b></a>
33-
</p>
24+
Simple money mask developed with pure JavaScript 🗃️ **0 _dependecies_**, 🍃 Super light just **1.65kB gzipped**, 🔒 **100% Secure** (no [npm audit problems](https://docs.npmjs.com/auditing-package-dependencies-for-security-vulnerabilities) or [dependabot issues](https://github.com/codermarcos/simple-mask-money/security/dependabot)) which you can run on **Client Side** and **Server Side**. [Try **live demo**](https://simple-mask-money.codermarcos.zone/).
3425

3526
## 🎉 Getting Started
3627

@@ -106,6 +97,8 @@ Here is a usage example with Vanilla JS:
10697
</body>
10798
```
10899

100+
> These are only the basic usage if you need configure some arguments you can check [documentation about full api reference](./docs/4.x.x/)
101+
109102
#### Vue JS Basic Example
110103

111104
Here is a usage example with Vue JS:
@@ -131,6 +124,9 @@ export default {
131124
</script>
132125
```
133126

127+
> These are only the basic usage if you need configure some arguments you can check [documentation about full api reference](./docs/4.x.x/)
128+
129+
134130
#### Angular Basic Example
135131

136132
Here is a usage example with Angular JS:
@@ -145,8 +141,7 @@ import { Component, OnInit, AfterViewInit } from '@angular/core';
145141
export class InputMoneyComponent implements AfterViewInit, OnDestroy {
146142

147143
ngAfterViewInit() {
148-
// set mask on your input you can pass a querySelector or your input element and options
149-
setMask('#my-input');
144+
setMask('#my-input'); // set mask on your input you can pass a querySelector or your input element and options
150145
}
151146

152147
ngOnDestroy() {
@@ -155,6 +150,9 @@ export class InputMoneyComponent implements AfterViewInit, OnDestroy {
155150
}
156151
```
157152

153+
> These are only the basic usage if you need configure some arguments you can check [documentation about full api reference](./docs/4.x.x/)
154+
155+
158156
## 📚 Detailed documentation
159157

160158
Read the [docs](docs/) or chose your implementation to check an example:

docs/README.md

+8-17
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
1-
<h1 align="center">Documentation SimpleMaskMoney</h1>
1+
# Documentation SimpleMaskMoney
22

3-
<h3 align="center"><b>WARNING</b></h3>
3+
> ⚠️ **WARNING**
4+
> If you are having problems please check the version that you are using.
5+
> This package follows the [semver (**semantic versioning**)](https://semver.org/) try to keep it updated with the [latest version](https://github.com/codermarcos/simple-mask-money).
46
5-
<h5 align="center">
6-
if you are having problems check the version you are using.
7-
<a href="2.x.x/#readme">
8-
The docs to old (2.x.x) version stay <b>here</b>
9-
</a>
10-
</h5>
7+
Please read api the docs equivalent to your version or if you prefer [see the examples](../examples/#readme):
118

12-
<p align="center">
13-
Simple money mask use a <a href="https://semver.org/">semver (semantic version)</a> please read api the docs equivalent to your version or if you prefer <a href="../examples/#readme">see the examples</a>.
14-
</p>
15-
16-
[4.x.x](4.x.x/#readme)
17-
18-
[3.x.x **(deprecated)**](3.x.x/#readme)
19-
20-
[2.x.x **(deprecated)**](2.x.x/#readme)
9+
- [4.x.x **latest**](4.x.x/#readme)
10+
- [~~3.x.x~~ **(deprecated)**](3.x.x/#readme)
11+
- [~~2.x.x~~ **(deprecated)**](2.x.x/#readme)

0 commit comments

Comments
 (0)