Skip to content

Commit 992b958

Browse files
committed
Updated docs
1 parent 0e02dee commit 992b958

File tree

3 files changed

+22
-9
lines changed

3 files changed

+22
-9
lines changed

DOCUMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Runs COBOL code from Node.JS side.
1111
- **Object** `options`: An object containing the following fields:
1212
- `cwd` (String): Where the COBOL code will run (by default in the current working directory)
1313
- `args` (Array): An array of strings to pass to the COBOL process.
14-
- `free` (Boolean): Use free option while compiling with GnuCobol
14+
- `compileargs` (Object): Use to specificy cobc compiler options
1515
- `stdin` (Stream): An optional stdin stream used to pipe data to the stdin stream of the COBOL process.
1616
- `stderr` (Stream): An optional stderr stream used to pipe data to the stdin stream of the COBOL process.
1717
- `stdeout` (Stream): An optional stdout stream used to pipe data to the stdin stream of the COBOL process.

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-17 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
3+
Copyright (c) 2013-18 Ionică Bizău <bizauionica@gmail.com> (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: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,20 @@
1111
1212
## Can I use this on production?
1313

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

1617

1718
## Installation
1819

20+
1921
Currently GNUCobol is required. If you are using a debian-based distribution you can install it using:
2022

2123
```sh
2224
$ sudo apt-get install open-cobol
2325
```
2426

27+
2528
:bulb: It would be interesting to fallback into a COBOL compiler written in NodeJS. [Contributions are welcome!][contributing] :smile:
2629

2730
Then, install the `cobol` package.
@@ -30,6 +33,7 @@ Then, install the `cobol` package.
3033
$ npm i cobol
3134
```
3235

36+
3337
## :clipboard: Example
3438

3539

@@ -49,7 +53,11 @@ Cobol(function () {/*
4953
DISPLAY "Hello world".
5054
PROGRAM-DONE.
5155
STOP RUN.
52-
*/}, function (err, data) {
56+
*/}, {
57+
compileargs:{
58+
free: true
59+
}
60+
}, function (err, data) {
5361
console.log(err || data);
5462
});
5563
// => "Hello World"
@@ -113,9 +121,11 @@ There are few ways to get help:
113121

114122
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.
115123
2. For bug reports and feature requests, open issues. :bug:
124+
116125
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
117126

118127

128+
119129
## :memo: Documentation
120130

121131

@@ -128,7 +138,7 @@ Runs COBOL code from Node.JS side.
128138
- **Object** `options`: An object containing the following fields:
129139
- `cwd` (String): Where the COBOL code will run (by default in the current working directory)
130140
- `args` (Array): An array of strings to pass to the COBOL process.
131-
- `free` (Boolean): Use free option while compiling with GnuCobol
141+
- `compileargs` (Object): Use to specificy cobc compiler options
132142
- `stdin` (Stream): An optional stdin stream used to pipe data to the stdin stream of the COBOL process.
133143
- `stderr` (Stream): An optional stderr stream used to pipe data to the stdin stream of the COBOL process.
134144
- `stdeout` (Stream): An optional stdout stream used to pipe data to the stdin stream of the COBOL process.
@@ -165,6 +175,7 @@ this takes time. You can integrate and use these projects in your applications *
165175

166176
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
167177

178+
168179
- Starring and sharing the projects you like :rocket:
169180
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
170181
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
@@ -173,6 +184,7 @@ However, if you get some profit from this or just want to encourage me to contin
173184

174185
![](https://i.imgur.com/z6OQI95.png)
175186

187+
176188
Thanks! :heart:
177189

178190

@@ -194,14 +206,15 @@ If you are using this library in one of your projects, add it in this list. :spa
194206

195207
[MIT][license] © [Ionică Bizău][website]
196208

197-
[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg
198-
[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg
199-
[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg
200-
[badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg
209+
210+
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
211+
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
212+
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
213+
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
214+
201215
[patreon]: https://www.patreon.com/ionicabizau
202216
[amazon]: http://amzn.eu/hRo9sIZ
203217
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
204-
[donate-now]: http://i.imgur.com/6cMbHOC.png
205218

206219
[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
207220
[website]: https://ionicabizau.net

0 commit comments

Comments
 (0)