Missing basic documentation

[arepetti]

Basic documentation is still missing, ideally at least these documents should be written:

• README.md to quickly introduce the topic and this library.
• Wiki pages to introduce license management topics, best practices and usage examples.

[chugh97]

I quite liked this library. Can you send me this being used in a sample exe application so I can then use it. At the moment I am unsure as to where the Server lib goes? Does this have to be deployed behind a webapi service ? Small document would help me immensely.

[arepetti]

Hi, it’s still not production-ready then do proper testing if you need to use it. I’m little bit busy in this moment but I hope I can post some decent examples next week. In general: “server library” must NOT ever be deployed to clients because it contains the code to create a license. Workflow is like this:

Client: customer creates a “contact” and send to you that file (or copy & paste via e-mail or POST it to an on-line web server). Contact contains enough hardware information to uniquely identify that client.

Server: these components are PRIVATE and they be used from an utility (GUI or command line) you write or by a web-server. They receive in input the “contact” generated client side and they create a license (which optionally may include a list of available features and/or an expiration date). This license is tied to a specified hardware (the same one for which “contact” has been created). You send license back to client.

Client: your application check for the license and validate it (see the toy example LicenseManager.cs). If license isn’t valid...quit otherwise check for required feature(s).

Few code examples are in Tests\UseCases.cs.

I hope I can write some basic information and at least one example as soon as possible.

[chugh97]

Thanks a lot

Sent from my iPhone

On 6 May 2016, at 14:22, Adriano Repetti [email protected] wrote:

Hi, it’s still not production-ready then do proper testing if you need to use it. I’m little bit busy in this moment but I hope I can post some decent examples next week. In general: “server library” must NOT ever be deployed to clients because it contains the code to create a license. Workflow is like this:

Client: customer creates a “contact” and send to you that file (or copy & paste via e-mail or POST it to an on-line web server). Contact contains enough hardware information to uniquely identify that client.

Server: these components are PRIVATE and they be used from an utility (GUI or command line) you write or by a web-server. They receive in input the “contact” generated client side and they create a license (which optionally may include a list of available features and/or an expiration date). This license is tied to a specified hardware (the same one for which “contact” has been created). You send license back to client.

Client: your application check for the license and validate it (see the toy example LicenseManager.cs). If license isn’t valid...quit otherwise check for required feature(s).

Few code examples are in Tests\UseCases.cs.

I hope I can write some basic information and at least one example as soon as possible.

From: Shaleen Chugh [mailto:[email protected]] Sent: venerdì 6 maggio 2016 15:13 To: arepetti/licensemanager Cc: Adriano Repetti; Author Subject: Re: [arepetti/licensemanager] Missing basic documentation (#6)

I quite liked this library. Can you send me this being used in a sample exe application so I can then use it. At the moment I am unsure as to where the Server lib goes? Does this have to be deployed behind a webapi service ? Small document would help me immensely.

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub https://github.com/arepetti/licensemanager/issues/6#issuecomment-217435862 https://github.com/notifications/beacon/AKEgMYhpbJRn1z0ZULG2xfLGio5_5Lc_ks5p-z5DgaJpZM4IX_rJ.gif

— You are receiving this because you commented. Reply to this email directly or view it on GitHub

[arepetti]

@chugh97 I just added a basic example (Examples\ConsoleCalculator) and I updated README.md with some useful information to begin with. Please let me know if you find any issue or you have any problem with that.