Sleep Diary Core Library

Documentation and code for manipulating sleep diaries

Project maintained by sleepdiary Hosted on GitHub Pages — Theme by mattgraham

Sleep Diary Core Library

Documentation and code for file formats that record circadian rhythms.

Format documentation

Third-party documentation for a variety of file formats. These describe issues that implementors may face in practice, but which are not mentioned in the official documentation.

The example code can translate these formats to and from Standard format, which provides a standard interface for common functionality.

JavaScript library

Each format includes example code for loading and saving documents in the relevant format. They have been packaged into a JavaScript library you can use in your own projects.

To check if the project works in your browser, try the browser-based unit tests. Then download the library and check out the library documentation.

Get Involved

I found a bug, how should I tell you?

Create a new bug report and we’ll get right on it.

I’d like to request a new feature, what should I say?

Please create a new feature request. We’ll try to sort out your problem.

I’d like to change the code, how do I get started?

Take a look at our getting started guide. Or if you’d like to talk to someone first, open a discussion and describe what you’re planning.

License

Sleep Diary Core Library comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions. For details, see the license statement.