Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Feb 28, 2018
1 parent 0e02dee commit 992b958
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 9 deletions.
2 changes: 1 addition & 1 deletion DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Runs COBOL code from Node.JS side.
- **Object** `options`: An object containing the following fields:
- `cwd` (String): Where the COBOL code will run (by default in the current working directory)
- `args` (Array): An array of strings to pass to the COBOL process.
- `free` (Boolean): Use free option while compiling with GnuCobol
- `compileargs` (Object): Use to specificy cobc compiler options
- `stdin` (Stream): An optional stdin stream used to pipe data to the stdin stream of the COBOL process.
- `stderr` (Stream): An optional stderr stream used to pipe data to the stdin stream of the COBOL process.
- `stdeout` (Stream): An optional stdout stream used to pipe data to the stdin stream of the COBOL process.
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2013-17 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Copyright (c) 2013-18 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,20 @@
## Can I use this on production?


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


## Installation


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

```sh
$ sudo apt-get install open-cobol
```


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

Then, install the `cobol` package.
Expand All @@ -30,6 +33,7 @@ Then, install the `cobol` package.
$ npm i cobol
```


## :clipboard: Example


Expand All @@ -49,7 +53,11 @@ Cobol(function () {/*
DISPLAY "Hello world".
PROGRAM-DONE.
STOP RUN.
*/}, function (err, data) {
*/}, {
compileargs:{
free: true
}
}, function (err, data) {
console.log(err || data);
});
// => "Hello World"
Expand Down Expand Up @@ -113,9 +121,11 @@ There are few ways to get help:

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.
2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:



## :memo: Documentation


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

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:


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

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


Thanks! :heart:


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

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

[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg

[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg

[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[donate-now]: http://i.imgur.com/6cMbHOC.png

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

0 comments on commit 992b958

Please sign in to comment.