Skip to content

Commit 24b8562

Browse files
committed
Updated docs
1 parent 0cb76d6 commit 24b8562

File tree

4 files changed

+102
-15
lines changed

4 files changed

+102
-15
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ node_modules
66
*.env
77
.DS_Store
88
package-lock.json
9+
.bloggify/*

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2013-19 Ionică Bizău <[email protected]> (https://ionicabizau.net)
3+
Copyright (c) 2013-20 Ionică Bizău <[email protected]> (https://ionicabizau.net)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 99 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,64 @@
11
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
22

33

4+
5+
6+
7+
8+
9+
410
[![cobol](http://i.imgur.com/DutRzDr.png)](#)
511

12+
13+
14+
15+
16+
17+
18+
19+
20+
21+
622
# cobol
723

824
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/cobol.svg)](https://www.npmjs.com/package/cobol) [![Downloads](https://img.shields.io/npm/dt/cobol.svg)](https://www.npmjs.com/package/cobol) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
925

1026
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
1127

28+
29+
30+
31+
32+
33+
1234
> COBOL bridge for NodeJS which allows you to run COBOL code from NodeJS.
1335
36+
37+
38+
39+
40+
1441
## Can I use this on production?
1542

1643

1744
Of course, you can! It's production ready! If you ever did such a thing, [ping me (@IonicaBizau)](https://twitter.com/IonicaBizau). :boom: :dizzy:
1845

1946

47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
58+
59+
60+
61+
2062
## Installation
2163

2264

@@ -36,6 +78,12 @@ $ npm i cobol
3678
```
3779

3880

81+
82+
83+
84+
85+
86+
3987
## :clipboard: Example
4088

4189

@@ -117,17 +165,28 @@ Cobol(function () {/*
117165

118166

119167

168+
169+
170+
171+
172+
173+
174+
175+
120176
## :question: Get Help
121177

122178
There are few ways to get help:
123179

180+
181+
124182
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
125183
2. For bug reports and feature requests, open issues. :bug:
126-
127184
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
128185

129186

130187

188+
189+
131190
## :memo: Documentation
132191

133192

@@ -150,6 +209,11 @@ Runs COBOL code from Node.JS side.
150209

151210

152211

212+
213+
214+
215+
216+
153217
## :newspaper: Press Highlights
154218

155219
This project has become more popular than I expected. :smile: If you wrote or found an article about this project that is not in the list below, please [add it][contributing].
@@ -166,12 +230,17 @@ This project has become more popular than I expected. :smile: If you wrote or fo
166230
- [3 open source projects for modern COBOL development](http://opensource.com/life/15/10/open-source-cobol-development) ([OpenSource.com](http://opensource.com/), by [Joshua Allen Holm](http://opensource.com/users/holmja))
167231

168232

233+
234+
235+
236+
237+
238+
169239
## :yum: How to contribute
170240
Have an idea? Found a bug? See [how to contribute][contributing].
171241

172242

173243
## :sparkling_heart: Support my projects
174-
175244
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
176245
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
177246

@@ -190,17 +259,32 @@ However, if you get some profit from this or just want to encourage me to contin
190259
Thanks! :heart:
191260

192261

262+
263+
264+
265+
266+
267+
268+
269+
270+
271+
272+
273+
274+
275+
193276
## :dizzy: Where is this library used?
194277
If you are using this library in one of your projects, add it in this list. :sparkles:
195278

279+
- `cobol-promises`
280+
281+
282+
283+
284+
196285

197-
- [`cobol-promises`](https://github.com/IonicaBizau/node-cobol-promises)—COBOL bridge for NodeJS with promises support.
198286

199-
## :sparkles: Related
200287

201-
- [`node.cobol`](https://github.com/IonicaBizau/node.cobol#readme)—Node.js bridge for COBOL which allows you to run Node.js code from COBOL.
202-
- [`fortran`](https://github.com/IonicaBizau/node-fortran)—Fortran bridge for Node.js which allows you to run Fortran code from Node.js.
203-
- [`node.fortran`](https://github.com/IonicaBizau/node.fortran#readme)—Execute Node.js in your Fortran programs.
204288

205289

206290

@@ -209,16 +293,18 @@ If you are using this library in one of your projects, add it in this list. :spa
209293
[MIT][license] © [Ionică Bizău][website]
210294

211295

296+
297+
298+
299+
300+
[license]: /LICENSE
301+
[website]: https://ionicabizau.net
302+
[contributing]: /CONTRIBUTING.md
303+
[docs]: /DOCUMENTATION.md
212304
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
213305
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
214306
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
215307
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
216-
217308
[patreon]: https://www.patreon.com/ionicabizau
218309
[amazon]: http://amzn.eu/hRo9sIZ
219310
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
220-
221-
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2013#license-mit
222-
[website]: https://ionicabizau.net
223-
[contributing]: /CONTRIBUTING.md
224-
[docs]: /DOCUMENTATION.md

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,4 @@
113113
"bloggify.json",
114114
"bloggify/"
115115
]
116-
}
116+
}

0 commit comments

Comments
 (0)