@neurosity/sdk/README.md

Neurosity SDK

# Neurosity SDK

The Neurosity software processes and manages the data produced by [Neurosity headsets](https://neurosity.co) which measures, tracks and monitors EEG brainwaves.

This repository is where [Neurosity](https://neurosity.co) develops the SDK. This source code is available to everyone under the standard [MIT license](./LICENSE) and the documentation is can be found on [docs.neurosity.co](https://docs.neurosity.co/). Thank you for visiting this repository.

This README file is a hub to give you some information about the SDK. At a high-level we seek to use the SDK to provide the following solutions:

- Universal JavaScript support: Node/Browser/Electron
- Event-driven multi-client real-time architecture
- Time synchronize clients to Neurosity devices

## Contributing

There are many ways you can participate in the project, for example:

- [Submit bugs and feature requests](https://github.com/neurosity/neurosity-sdk-js/issues), and help us verify as they are checked in.
- Review [source code changes](https://github.com/neurosity/neurosity-sdk-js/pulls).
- Review the [documentation](https://github.com/neurosity/neurosity-sdk-js/tree/master/website) and make pull requests for anything from typos to new content.

If you are interested in fixing issues and contributing directly to the code base,
please see the document [How to Contribute](https://github.com/Neurosity/neurosity-sdk-js/wiki/How-to-Contribute), which covers the following:

- [How to install and run from source](https://github.com/neurosity/neurosity-sdk-js/wiki/How-to-Contribute#contributing-to-notionjs)
- [Coding guidelines](https://github.com/neurosity/neurosity-sdk-js/wiki/Coding-Guidelines)
- [Submitting pull requests](https://github.com/neurosity/neurosity-sdk-js/wiki/How-to-Contribute#pull-requests)
- [Finding an issue to work on](https://github.com/neurosity/neurosity-sdk-js/wiki/How-to-Contribute#where-to-contribute)

## Feedback

- Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/neurosity-sdk-js)
- [Request a new feature](https://github.com/neurosity/neurosity-sdk-js/blob/master/CONTRIBUTING.md)
- Discuss a new feature on our [community](https://support.neurosity.co/hc/en-us/community/topics)
- Up vote [popular feature requests](https://github.com/neurosity/neurosity-sdk-js/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc)
- [File an issue](https://github.com/neurosity/neurosity-sdk-js/issues)
- Follow [@neurosity](https://twitter.com/neurosity) and let us know what you think!

## Code of Conduct

This project has adopted a [Code of Conduct](https://github.com/neurosity/neurosity-sdk-js/blob/master/CODE_OF_CONDUCT.md). Contact [opensource@neurosity.co](mailto:opensource@neurosity.co) with any additional questions or comments.

## License

Copyright (c) Neurosity, Inc. All rights reserved.

Licensed under the [MIT license](./LICENSE).