diff --git a/doc/TODO b/doc/TODO deleted file mode 100644 index e69de29..0000000 diff --git a/doc/info.txt b/doc/info.txt new file mode 100644 index 0000000..b171c8d --- /dev/null +++ b/doc/info.txt @@ -0,0 +1,59 @@ +SecureX Message Passing library (libsxmp) +----------------------------------------- + +1. Purposes. +This library is designed to implement secure message passing protocol with +embedded RPC support. One of the goal was to implement very flexible security +permission types i.e. to have a few methods to limit access depends on some +information. +It might be used in a wide area of different services kind. +Going further, the other important goal was a simple and clean protocol and +S-expression was used (it also useful if you want remote host to evaluate +something). + +2. Documentation +The best API documentation in *nix world is a manpages. This is the option used +in this library. +README file contains the description of build process, but it's very common for +*nix systems. + +3. Examples +To give a start point examples was created (stupid and simple ones), below the +list of currently existing examples: + * filelistd/filelistc - a file lister daemon and client. This is a simple + client/server application used to list the directory content from the remote + host using client application +All examples located within the project under the `examples/' directory. + +4. Tools and scripts +A few ones exists (or will appear within the next releases). The lists below. +4.1 Scripts (located under `scripts/') + * create-x509-example.sh - a simple script to create x.509 certificates i.e. + it will create a root certificate (public and private) and user x.509 signed + by the root. It useful to run examples or to quick start with development of + your own stuff. + +5. Contribute +Anyone can create a patches, submit fixes and new features, examples, documents +or any other useful stuff (beer or few €/$ is also useful). +All this might be discussed with the author (contact me via the following email +a.vdolainen@gmail.com). + +6. Is it stable ? +Yes, but debugging, fixing is ongoing process. To be sure better to use the +latest release, not the last stuff commited to the git. +Later unit tests will be created to make it `rock solid stable' or how it might +sounds `very mature'. BTW, in the process of the old releases development many +bugs (or memory leaks) was found in other libraries. + +7. Feedback +I will be quite happy not only in case of any donation made, but also if you +will inform me about your use case of this library. +Also, it will be nice to add this library to linux distributions, *bsd as +many as possible (if so, please let me know). +Anyways, you feel free to write me about questions and other things. + +8. Contact +Author: Alexander Vdolainen +Please be patient, my time zone is EET/EEST (UTC+2/UTC+3 (summer time)), but in +most cases I will reply quite quickly.