Skip to content

Commit 9fdf22c

Browse files
author
ADMSK\AVROGAL1
committed
docs: updates on workflows
Added information on documentation
1 parent 23021b4 commit 9fdf22c

File tree

1 file changed

+61
-60
lines changed

1 file changed

+61
-60
lines changed

README.md

Lines changed: 61 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# _Json fields_
1+
# *Json fields*
22

33
> GitHub Action to process JSON file by provided fields
44
@@ -10,7 +10,7 @@
1010
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
1111
[![Chat](https://img.shields.io/badge/chat-discussions-success.svg)](https://github.com/AlexRogalskiy/github-action-json-fields/discussions)
1212

13-
[![DeepScan grade](https://deepscan.io/api/teams/11946/projects/16314/branches/347248/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=11946&pid=16314&bid=347248)
13+
[![DeepScan grade](https://deepscan.io/api/teams/11946/projects/16314/branches/347248/badge/grade.svg)](https://deepscan.io/dashboard#view=project\&tid=11946\&pid=16314\&bid=347248)
1414
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/AlexRogalskiy/github-action-json-fields)
1515
![GitHub Release Date](https://img.shields.io/github/release-date/AlexRogalskiy/github-action-json-fields)
1616
![Lines of code](https://tokei.rs/b1/github/AlexRogalskiy/github-action-json-fields?category=lines)
@@ -40,38 +40,30 @@
4040
[![Open questions](https://img.shields.io/badge/Open-questions-blue.svg?style=flat-curved)](https://github.com/AlexRogalskiy/github-action-json-fields/labels/question)
4141
[![Open bugs](https://img.shields.io/badge/Open-bugs-red.svg?style=flat-curved)](https://github.com/AlexRogalskiy/github-action-json-fields/labels/bug)
4242

43-
## _Table of contents_
44-
45-
<!--ts-->
46-
* [<em>Json fields</em>](#json-fields)
47-
* [<em>Table of contents</em>](#table-of-contents)
48-
* [<em>Description</em>](#description)
49-
* [<em>Inputs</em>](#inputs)
50-
* [sourceData](#sourcedata)
51-
* [mode](#mode)
52-
* [unique](#unique)
53-
* [duplicate](#duplicate)
54-
* [jsonPath](#jsonpath)
55-
* [jsonFields](#jsonfields)
56-
* [sourceFile](#sourcefile)
57-
* [targetPath](#targetpath)
58-
* [targetFile](#targetfile)
59-
* [<em>Outputs</em>](#outputs)
60-
* [changed](#changed)
61-
* [true](#true)
62-
* [false](#false)
63-
* [<em>Examples</em>](#examples)
64-
* [<em>Visitor stats</em>](#visitor-stats)
65-
* [<em>Licensing</em>](#licensing)
66-
* [<em>Authors</em>](#authors)
67-
* [<em>Versioning</em>](#versioning)
68-
* [<em>Contribution</em>](#contribution)
69-
* [<em>Acknowledgement</em>](#acknowledgement)
70-
* [<em>Forks</em>](#forks)
71-
* [<em>Development Support</em>](#development-support)
72-
<!--te-->
73-
74-
## _Description_
43+
## *Table of contents*
44+
45+
- [*Description*](#description)
46+
- [*Inputs*](#inputs)
47+
- [`sourceData`](#sourcedata)
48+
- [`mode`](#mode)
49+
- [`jsonPath`](#jsonpath)
50+
- [`jsonFields`](#jsonfields)
51+
- [`sourceFile`](#sourcefile)
52+
- [`targetPath`](#targetpath)
53+
- [`targetFile`](#targetfile)
54+
- [*Outputs*](#outputs)
55+
- [`changed`](#changed)
56+
- [*Examples*](#examples)
57+
- [*Visitor stats*](#visitor-stats)
58+
- [*Licensing*](#licensing)
59+
- [*Authors*](#authors)
60+
- [*Versioning*](#versioning)
61+
- [*Contribution*](#contribution)
62+
- [*Acknowledgement*](#acknowledgement)
63+
- [*Forks*](#forks)
64+
- [*Development Support*](#development-support)
65+
66+
## *Description*
7567

7668
<p align="center" style="text-align:center;">
7769
<a href="https://www.typescriptlang.org/">
@@ -90,7 +82,7 @@
9082

9183
Processes JSON file by provided list of fields and file source parameters.
9284

93-
## _Inputs_
85+
## *Inputs*
9486

9587
### `sourceData`
9688

@@ -182,7 +174,7 @@ More information on JSON path queries can be found at [jsonpath](https://www.npm
182174

183175
**Optional** Target JSON destination file name (default **sourceFile**)
184176

185-
## _Outputs_
177+
## *Outputs*
186178

187179
### `changed`
188180

@@ -196,7 +188,7 @@ When JSON source file successfully processed and results stored to destination f
196188

197189
When error occurred while processing JSON source file
198190

199-
## _Examples_
191+
## *Examples*
200192

201193
```yml
202194
- name: Process JSON file by fields
@@ -214,38 +206,38 @@ Running locally:
214206
215207
- `npm run start:action --action github-action-json-fields --mode 'unique' --jsonPath 'african' --jsonFields 'text' --sourceFile './data/african_proverbs.json' --targetPath './data' --targetFile 'african_proverbs_unique.json'`
216208

217-
## _Visitor stats_
209+
## *Visitor stats*
218210

219-
[![GitHub page hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FAlexRogalskiy%2Fgithub-action-json-fields&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true)](https://hits.seeyoufarm.com)
211+
[![GitHub page hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FAlexRogalskiy%2Fgithub-action-json-fields\&count_bg=%2379C83D\&title_bg=%23555555\&icon=\&icon_color=%23E7E7E7\&title=hits\&edge_flat=true)](https://hits.seeyoufarm.com)
220212

221213
![GitHub stars](https://img.shields.io/github/stars/AlexRogalskiy/github-action-json-fields?style=social)
222214
![GitHub forks](https://img.shields.io/github/forks/AlexRogalskiy/github-action-json-fields?style=social)
223215
![GitHub watchers](https://img.shields.io/github/watchers/AlexRogalskiy/github-action-json-fields?style=social)
224216

225-
## _Licensing_
217+
## *Licensing*
226218

227-
_**Json Fields**_ is distributed under LGPL version 3 or later,
228-
[[License](https://github.com/AlexRogalskiy/github-action-json-fields/blob/master/LICENSE)]. LGPLv3 is additional
219+
***Json Fields*** is distributed under LGPL version 3 or later,
220+
\[[License](https://github.com/AlexRogalskiy/github-action-json-fields/blob/master/LICENSE)]. LGPLv3 is additional
229221
permissions on top of GPLv3.
230222

231223
![license](https://user-images.githubusercontent.com/19885116/48661948-6cf97e80-ea7a-11e8-97e7-b45332a13e49.png)
232224

233-
## _Authors_
225+
## *Authors*
234226

235-
_**Json Fields**_ is maintained by the following GitHub team-members:
227+
***Json Fields*** is maintained by the following GitHub team-members:
236228

237229
- [![Author](https://img.shields.io/badge/author-AlexRogalskiy-FB8F0A)](https://github.com/AlexRogalskiy)
238230

239231
with community support please contact with us if you have some question or proposition.
240232

241-
## _Versioning_
233+
## *Versioning*
242234

243235
The project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on
244236
this repository][tags].
245237

246-
## _Contribution_
238+
## *Contribution*
247239

248-
[![Contributors Display](https://badges.pufler.dev/contributors/AlexRogalskiy/github-action-json-fields?size=50&padding=5&bots=true)](https://badges.pufler.dev)
240+
[![Contributors Display](https://badges.pufler.dev/contributors/AlexRogalskiy/github-action-json-fields?size=50\&padding=5\&bots=true)](https://badges.pufler.dev)
249241

250242
Please read
251243
[CONTRIBUTING.md](https://github.com/AlexRogalskiy/github-action-json-fields/blob/master/.github/CONTRIBUTING.md)
@@ -260,39 +252,48 @@ specification. Contributions of any kind are welcome!
260252

261253
See also the list of [contributors][contributors] who participated in this project.
262254

263-
## _Acknowledgement_
255+
## *Acknowledgement*
264256

265257
[![Stargazers repo roster for @AlexRogalskiy/github-action-json-fields](https://reporoster.com/stars/AlexRogalskiy/github-action-json-fields)][stars]
266258

267-
## _Forks_
259+
## *Forks*
268260

269261
[![Forkers repo roster for @AlexRogalskiy/github-action-json-fields](https://reporoster.com/forks/AlexRogalskiy/github-action-json-fields)][forkers]
270262

271-
## _Development Support_
263+
## *Development Support*
272264

273-
Like _**Json Fields**_ ? Consider buying me a coffee :\)
265+
Like ***Json Fields*** ? Consider buying me a coffee :)
274266

275-
[![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square&logo=patreon&color=e64413)](https://www.patreon.com/alexrogalskiy)
267+
[![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square\&logo=patreon\&color=e64413)](https://www.patreon.com/alexrogalskiy)
276268
[![Buy Me A Coffee](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=buy%20me%20a%20coffee)](https://www.buymeacoffee.com/AlexRogalskiy)
277269
[![KoFi](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi)](https://ko-fi.com/alexrogalskiy)
278270

279-
---
271+
***
280272

281-
[![forthebadge](https://img.shields.io/badge/made%20with-%20typescript-C1282D.svg?logo=typescript&style=for-the-badge)](https://www.typescriptlang.org/)
282-
[![forthebadge](https://img.shields.io/badge/powered%20by-%20github-7116FB.svg?logo=github&style=for-the-badge)](https://github.com/)
283-
[![forthebadge](https://img.shields.io/badge/build%20with-%20%E2%9D%A4-B6FF9B.svg?logo=heart&style=for-the-badge)](https://forthebadge.com/)
273+
[![forthebadge](https://img.shields.io/badge/made%20with-%20typescript-C1282D.svg?logo=typescript\&style=for-the-badge)](https://www.typescriptlang.org/)
274+
[![forthebadge](https://img.shields.io/badge/powered%20by-%20github-7116FB.svg?logo=github\&style=for-the-badge)](https://github.com/)
275+
[![forthebadge](https://img.shields.io/badge/build%20with-%20%E2%9D%A4-B6FF9B.svg?logo=heart\&style=for-the-badge)](https://forthebadge.com/)
284276

285277
[repo]: https://github.com/AlexRogalskiy/github-action-json-fields
278+
286279
[tags]: https://github.com/AlexRogalskiy/github-action-json-fields/tags
280+
287281
[issues]: https://github.com/AlexRogalskiy/github-action-json-fields/issues
282+
288283
[pulls]: https://github.com/AlexRogalskiy/github-action-json-fields/pulls
284+
289285
[wiki]: https://github.com/AlexRogalskiy/github-action-json-fields/wiki
286+
290287
[stars]: https://github.com/AlexRogalskiy/github-action-json-fields/stargazers
288+
291289
[forkers]: https://github.com/AlexRogalskiy/github-action-json-fields/network/members
290+
292291
[contributors]: https://github.com/AlexRogalskiy/github-action-json-fields/graphs/contributors
292+
293293
[license_id]: https://img.shields.io/github/license/AlexRogalskiy/github-action-json-fields
294+
294295
[license_content]: https://github.com/AlexRogalskiy/github-action-json-fields/blob/master/LICENSE
295-
[total_usages]:
296-
https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DAlexRogalskiy%2Fgithub-action-json-fields%26badge%3Dtrue
297-
[search_results]:
298-
https://github.com/search?o=desc&q=AlexRogalskiy/github-action-json-fields+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code
296+
297+
[total_usages]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DAlexRogalskiy%2Fgithub-action-json-fields%26badge%3Dtrue
298+
299+
[search_results]: https://github.com/search?o=desc&q=AlexRogalskiy/github-action-json-fields+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code

0 commit comments

Comments
 (0)