Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Shape up the basic usage examples #131

Open
aqrln opened this issue May 5, 2017 · 2 comments
Open

Shape up the basic usage examples #131

aqrln opened this issue May 5, 2017 · 2 comments
Labels
doc

Comments

@aqrln
Copy link
Member

aqrln commented May 5, 2017

Is anyone willing to write a couple of usage examples (something completely basic like a server with one method and a client that calls it to begin with, and a bit more complex apps later)? The examples directory is where they are supposed to reside in.

@nechaido would you be interested in doing that?
/cc @belochub
@aqrln aqrln added the doc label May 5, 2017
@aqrln aqrln added this to the 1.0.0 milestone May 5, 2017
@nechaido
Copy link
Member

nechaido commented May 5, 2017

@aqrln yes, I am. But I think we`ll need tests first. Also good written test is an example itself, we can use them as examples if we remove asserts and other testing stuff. Am I right?

@aqrln
Copy link
Member Author

aqrln commented May 5, 2017

@nechaido good written tests are examples to some extent, but examples that are supposed to be examples are better examples ;)

But that's okay, if you want to dedicate your time to tests first, then go for it, that would be great 🎉

@belochub belochub mentioned this issue May 12, 2017
Closed
aqrln added a commit that referenced this issue May 12, 2017
@aqrln
doc: modernize README.md and add CoC
06a066c 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

Refs: #131
Refs: #163
aqrln added a commit that referenced this issue May 13, 2017
@aqrln
doc: modernize README.md and add CoC
f6a3e92 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
nechaido pushed a commit that referenced this issue May 18, 2017
@aqrln @nechaido
doc: modernize README.md and add CoC
1f5275e 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@nechaido nechaido removed this from the 1.0.0 milestone Jul 31, 2017
belochub pushed a commit that referenced this issue Jan 22, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
68c1b22 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit that referenced this issue Jan 22, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
b90041e 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this issue Jul 19, 2018
@aqrln
doc: modernize README.md and add CoC
1cc80c7 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this issue Jul 19, 2018
@aqrln
doc: modernize README.md and add CoC
3da9f2a 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this issue Jul 21, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
d4f85db 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@aqrln @nechaido