Merge pull request #30 from axiomhq/update

Contributing.md

@@ -0,0 +1,41 @@
+## How to Contribute
+
+👍🎉 First of all, thank you for your interest in Axiom-node! We'd love to accept your patches and contributions! 🎉👍
+
+This project accepts contributions. In order to contribute, you should pay attention to a few guidelines:
+
+## Reporting Issues
+
+Bugs, feature requests, and development-related questions should be directed to our [GitHub issue tracker](https://github.com/axiomhq/hyperloglog/issues).
+
+When reporting a bug, please try and provide as much context as possible such as your operating system, Go version and anything else that might be relevant to the bug. For feature requests, please explain what you're trying to do and how the requested feature would help you do that.
+
+## Setup
+
+[Fork](https://github.com/axiomhq/hyperloglog.git), then clone this repository:
+
+```
+git clone https://github.com/axiomhq/hyperloglog.git
+cd hyperloglog
+cd demo 
+go run hyperloglog_demo.go 
+```
+
+## Submitting Modifications
+
+1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.
+
+2. Follow the normal process of [forking](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.
+
+3. Go makes it very simple to ensure properly formatted code, so always run `go fmt` on your code before committing it.
+
+4. Do your best to have [well-formated commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+for each change. This provides consistency throughout the project and ensures that commit messages are able to be formatted properly by various git tools.
+
+5. Finally, push the commits to your fork and submit a [pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)
+
+### Once you've filed the PR:
+
+- One or more maintainers will use GitHub's review feature to review your PR.
+- If the maintainer asks for any changes, edit your changes, push, and ask for another review.
+- If the maintainer decides to suggest some improvements or alternatives, modify and make improvements. Once your changes are approved, one of the project maintainers will merge them.

LICENSE

@@ -1,6 +1,4 @@
-MIT License
-
-Copyright (c) 2017 Axiom Inc. <seif@axiom.sh>
+Copyright (c) 2021, Axiom, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +16,4 @@ 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.
+SOFTWARE.

README.md

@@ -1,6 +1,6 @@
-![Hyperloglog Logo](https://axiom.co/static/oss-hyperloglog.jpg)
+<img height="32" src="https://axiom.co/logo.svg">
 
-  ---
+---
 
 [![GoDoc](https://godoc.org/github.com/axiomhq/hyperloglog?status.svg)](https://godoc.org/github.com/axiomhq/hyperloglog) [![Go Report Card](https://goreportcard.com/badge/github.com/axiomhq/hyperloglog)](https://goreportcard.com/report/github.com/axiomhq/hyperloglog) [![CircleCI](https://circleci.com/gh/axiomhq/hyperloglog/tree/master.svg?style=svg)](https://circleci.com/gh/axiomhq/hyperloglog/tree/master)
 
@@ -40,8 +40,35 @@ A big thank you to Prof. Shigang Chen and his team at the University of Florida
 
 ---
 
-**An [Axiom](https://axiom.co) production.**
+## Documentation
+
+You can find the Axiom documentation [on the docs website.](https://docs.axiom.co/)
+
+The documentation is divided into several sections:
+
+- [Overview of Axiom](https://docs.axiom.co/usage/getting-started/)
+- **Installing Axiom:**
+    - [Axiom Cloud](https://docs.axiom.co/install/cloud/)
+    - [Desktop Demo](https://docs.axiom.co/install/demo/)
+    - [Runing Axiom on Kubernetes](https://docs.axiom.co/install/kubernetes/)
+- [Axiom API](https://docs.axiom.co/reference/api/)
+- [Axiom CLI](https://github.com/axiomhq/cli)
+- [Getting Support](https://www.axiom.co/support/)
+- [Data Shippers we support](https://docs.axiom.co/data-shippers/elastic-beats/)
+
+---
+
+## Contributing
+
+Kindly check our [contributing guide](https://github.com/axiomhq/hyperloglog/blob/main/Contributing.md) on how to propose bugfixes and improvements, and submitting pull requests to the project
+
+## License
+
+&copy; Axiom, Inc., 2021
+
+Distributed under MIT License (`The MIT License`).
+
+See [LICENSE](LICENSE) for more information.
 
-Do you enjoy solving problems like these? If so, get in touch with us at [careers@axiom.co](mailto:careers@axiom.co)!
 
-<a href="https://axiom.co"><img align="right" width="48" height="48" src="https://axiom.co/static/xiom-inverted-sunset.png"></a>
+<img align="right" width="48" height="48" src="https://axiom.co/xiom.svg">