Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Renato Pozzi authored May 1, 2021
1 parent 6a3df3f commit 7af0b80
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,38 @@ Open Source Analytics Platform - Designed for Humans & Developers :sunglasses:

Open source means the the code is open for anyone to read, comment on and suggest changes. Cookieless means the client side analytic code doesn’t use cookies. Analytic platform means it’s a system to collect, store and display analytic data such as the amount of users on your website at any one time.

## Getting Started 🤩

This is a public beta! Please star and watch the repository for big news :heart: we have also a simple [roadmap](https://trello.com/b/df17oLMm/aurora-roadmap) in order to track some good ideas.
### Getting Started 🤩

You can go up and running with Aurora by following the [Official Docs](https://docs.useaurora.app/). These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

## Deployment 🛫
### Deployment 🛫

You can deploy Aurora manually from this repo, or via Docker, please refer to the [Official Docs](https://docs.useaurora.app/) for the instructions.

### Roadmap 🗺️

Currently Writing
This is a public beta! Please star and watch the repository for big news :heart: we have a Trello [roadmap](https://trello.com/b/df17oLMm/aurora-roadmap) in order to track some good ideas.

## Built With 🏗️
### Built With 🏗️

- [NextJS](https://nextjs.org/) - NextJS
- [TailwindCSS](https://tailwindcss.com/) - TailwindCSS
- [KnexJS](https://knexjs.org/) - Database ORM

## Versioning 🚦
### Versioning 🚦

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/itsrennyman/aurora/tags).

## Authors 🙋
### Authors 🙋

- **Renato Pozzi** - _Initial work_ - [itsrennyman](https://github.com/itsrennyman)

## Stargazers 🌟
### Stargazers 🌟

[![Stargazers repo roster for @itsrennyman/aurora](https://reporoster.com/stars/itsrennyman/aurora)](https://github.com/itsrennyman/aurora/stargazers)

See also the list of [contributors](https://github.com/itsrennyman/aurora/contributors) who participated in this project.

## License
### License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

0 comments on commit 7af0b80

Please sign in to comment.