| 1 | <p align="center">
|
| 2 | <img src="internal/banner/Banner.png" width="400" max-width="90%" alt="Dynamoose" />
|
| 3 | </p>
|
| 4 |
|
| 5 | <p align="center">
|
| 6 | <a href="https://www.npmjs.com/package/dynamoose">
|
| 7 | <img src="https://img.shields.io/npm/v/dynamoose" alt="npm">
|
| 8 | </a>
|
| 9 | <a href="https://github.com/dynamoose/dynamoose/blob/master/LICENSE">
|
| 10 | <img src="https://img.shields.io/github/license/dynamoose/dynamoose" alt="License">
|
| 11 | </a>
|
| 12 | <a href="https://www.npmjs.com/package/dynamoose">
|
| 13 | <img src="https://img.shields.io/npm/dw/dynamoose" alt="npm Downloads">
|
| 14 | </a>
|
| 15 | <a href="https://github.com/dynamoose/dynamoose/actions">
|
| 16 | <img src="https://github.com/dynamoose/dynamoose/workflows/CI/badge.svg" alt="CI">
|
| 17 | </a>
|
| 18 | <a href="https://coveralls.io/github/dynamoose/dynamoose?branch=master">
|
| 19 | <img src="https://coveralls.io/repos/github/dynamoose/dynamoose/badge.svg?branch=master" alt="Coverage Status">
|
| 20 | </a>
|
| 21 | <a href="https://join.slack.com/t/dynamoose/shared_invite/enQtODM4OTI0MTc1NDc3LWI3MmNhMThmNmJmZDk5MmUxOTZmMGEwNGQzNTRkMjhjZGJlNGM5M2JmZjMzMzlkODRhMGY3MTQ5YjQ2Nzg3YTY">
|
| 22 | <img src="https://img.shields.io/badge/chat-on%20slack-informational.svg" alt="Slack Chat">
|
| 23 | </a>
|
| 24 | <a href="https://charlie.fish/contact">
|
| 25 | <img src="https://img.shields.io/badge/contact-me-blue" alt="Contact">
|
| 26 | </a>
|
| 27 | <a href="https://twitter.com/DynamooseJS">
|
| 28 | <img src="https://img.shields.io/twitter/follow/dynamoosejs?style=social" alt="Twitter">
|
| 29 | </a>
|
| 30 | </p>
|
| 31 |
|
| 32 | ---
|
| 33 |
|
| 34 | Dynamoose is a modeling tool for Amazon's DynamoDB (inspired by [Mongoose](https://mongoosejs.com/)).
|
| 35 |
|
| 36 | ### Getting Started
|
| 37 |
|
| 38 | Take a look at our [website](https://dynamoosejs.com) for information about how to get started.
|
| 39 |
|
| 40 | ### Resources
|
| 41 |
|
| 42 | #### General
|
| 43 |
|
| 44 | - [Website](https://dynamoosejs.com)
|
| 45 | - [Contributing Guide](CONTRIBUTING.md)
|
| 46 | - [Code of Conduct](CODE_OF_CONDUCT.md)
|
| 47 | - [Changelog](CHANGELOG.md)
|
| 48 | - [License](LICENSE)
|
| 49 |
|
| 50 | #### Social
|
| 51 |
|
| 52 | - [Slack](https://join.slack.com/t/dynamoose/shared_invite/enQtODM4OTI0MTc1NDc3LWI3MmNhMThmNmJmZDk5MmUxOTZmMGEwNGQzNTRkMjhjZGJlNGM5M2JmZjMzMzlkODRhMGY3MTQ5YjQ2Nzg3YTY)
|
| 53 | - [Twitter](https://twitter.com/DynamooseJS)
|
| 54 |
|
| 55 | ### Branch Strategy
|
| 56 |
|
| 57 | Below you will find the current branch strategy for the project. Work taking place on the branches listed below might be further ahead than the versions on NPM. All documentation links found below will also be reflective of the published version on NPM. If you would like to live dangouragely and run non released versions, you can run `npm install dynamoose/dynamoose#BRANCH` (replacing `BRANCH` with the branch listed below). You will also find the most up to date documentation in the `docs` folder of the branch.
|
| 58 |
|
| 59 | | Branch | Version | NPM Tag | Links |
|
| 60 | | --- | --- | --- | --- |
|
| 61 | | [`master`](https://github.com/dynamoose/dynamoose/tree/master) | 2.0.0 | latest | - [Documentation](https://dynamoosejs.com) |
|
| 62 | | [`alpha`](https://github.com/dynamoose/dynamoose/tree/alpha) | 2.1.0 | alpha | - [Documentation](https://github.com/dynamoose/dynamoose/tree/alpha/docs/docs)<br>- [Issue](https://github.com/dynamoose/dynamoose/issues/788) |
|