Add / update documentation

.gitignore

@@ -0,0 +1,13 @@
+**/apidoc
+**/obj
+**/bin
+**/dep
+**/lib
+*.d
+*.o
+*~
+*.swp
+README-orig.md
+TODO
+xchange/**
+redisx/**

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to the [Smithsonian/redisx](https://github.com/Smithsonian/smax-clib) library will be 
+documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to 
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+Initial public release.

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+the Center for Astrophysics | Harvard & Smithsonian.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing to RedisX
+
+
+The _SMA-X C/C++_ library is for everyone. And, it is developers like you who can make it better. Whether there is a 
+nagging issue you would like to fix, or a new feature you'd like to see, you can make a difference yourself. Make this 
+project a little bit your own, by submitting pull requests with fixes and enhancement. When you are ready, here are 
+the typical steps for contributing to the project:
+
+1. Old or new __Issue__? Whether you just found a bug, or you are missing a much needed feature, start by checking 
+open (and closed) [Issues](https://github.com/Smithsonian/smax/issues). If an existing issue seems like a 
+good match to yours, feel free to speak up, comment, or to offer help in resolving it. If you find no issues that 
+match, go ahead and create a new one.
+
+2. __Fork__. Is it something you'd like to help resolve? Great! You should start by creating your own fork of the 
+repository so you can work freely on your solution. I recommend that you place your work on a branch of your fork, 
+which is named either after the issue number, e.g. `issue-192`, or some other descriptive name, such as 
+`sentinel-support`.
+
+3. __Develop__. Experiment on your fork/branch freely. If you run into a dead-end, you can always abandon it (which is 
+why branches are great) and start anew. You can run `make all` to ensure that all components of the package and its 
+API documentation are also in order. Remember to synchronize your `main` branch by fetching changes from upstream 
+every once in a while, and merging them into your development branch. Don't forget to:
+
+   - Add __doxygen__ markup your new code. You can keep it sweet and simple, but make sure it properly explains your 
+   globally exposed functions, their arguments and return values. You should also cross-reference other functions / 
+   constants that are similar, related, or relevant to what you just added.
+
+4. __Pull Request__. Once you feel your work can be integrated, create a pull request from your fork/branch. You can 
+do that easily from the github page of your fork/branch directly. In the pull request, provide a concise description 
+of what you added or changed. Your pull request will be reviewed. You may get some feedback at this point, and maybe 
+there will be discussions about possible improvements or regressions etc. It's a good thing too, and your changes will 
+likely end up with added polish as a result. You can be all the more proud of it in the end!
+
+5. If all goes well, your pull-request will get merged, and will be included in the upcoming release of _smax-clib_. 
+Congratulations for your excellent work, and many thanks for dedicating some of your time for making this library a 
+little bit better. There will be many who will appreciate it. :-)
+
+
+If at any point you have questions, or need feedback, don't be afraid to ask. You can put your questions into the 
+issue you found or created, or your pull-request, or as a Q&A in 
+[Discussions](https://github.com/Smithsonian/smax_clib/discussions).
+
+

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>