From 2ff196bac487d0e42d52004c596c45ac9ea07726 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Mon, 10 Aug 2020 05:06:49 +0300 Subject: [PATCH] Updated docs --- .gitignore | 4 ++++ CONTRIBUTING.md | 6 ++++-- DOCUMENTATION.md | 5 +++++ LICENSE | 37 ++++++++++++++++++++----------------- 4 files changed, 33 insertions(+), 19 deletions(-) diff --git a/.gitignore b/.gitignore index 61f2900..2ca2591 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,7 @@ *~ *.log node_modules +*.env +.DS_Store +package-lock.json +.bloggify/* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b09a1db..763033e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,6 +59,8 @@ Contributions are more than welcome! Thanks! :sweat_smile: -[1]: https://github.com/IonicaBizau/share-term/issues -[2]: https://github.com/IonicaBizau/code-style \ No newline at end of file + +[1]: https://github.com/Share-Term/share-term/issues + +[2]: https://github.com/IonicaBizau/code-style diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 9591314..b2d8440 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,10 +1,12 @@ ## Documentation + You can see below the API reference of this module. ### `ShareTerm(options)` Creates a new instance of `ShareTerm`. #### Params + - **Object** `options`: The options object: - `host` (String): The remote server host. @@ -21,6 +23,7 @@ This is called internally after the client is connected. Connects the client to the remote server. #### Params + - **Object** `options`: The options object. - **Function** `callback`: The callback function. @@ -31,6 +34,7 @@ Connects the client to the remote server. Creates a new terminal share session. #### Params + - **Function** `callback`: The callback function. #### Return @@ -40,6 +44,7 @@ Creates a new terminal share session. Connects the client to an existing terminal share session. #### Params + - **Object** `options`: An object containing the following fields: - `id` (String): The terminal share session id. - `stdout` (Stream): The output stream (default: `process.stdout`). diff --git a/LICENSE b/LICENSE index ad4ac1b..d39203b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,24 @@ -The MIT License (MIT) +The KINDLY License +Copyright (c) 2015-20 Ionică Bizău -Copyright (c) 2015 Ionică Bizău +You have the permission to use this software, read its source code, modify and +redistribute it under the following terms: -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + - if you want to use this software or include parts of its code in a + closed-source or commercial project you should kindly ask the + author (via a private message or email) and get a positive answer + - this license should be included in the modified versions of this software + - in case of redistributing modified copies, you are encouraged to clearly + indicate that the copies are based on this work + - if you think that your redistributed copy is awesome, you are encouraged to + show the author of this software what you did and how you helped the others -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +You are free to install and use this software on as many machines as you want, +free of charge, making sure you met the terms above. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +You are encouraged to kindly support the software and its author by: + + - sharing his/her work + - reporting issues/bugs and asking for feature requests + - donating money or any other things that can help the author + - contribute on the software code by fixing bugs and adding features