Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add example repository to readme #21

Merged
merged 2 commits into from
Mar 3, 2024
Merged

docs: add example repository to readme #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
436b6f8
docs: add example repository to readme
fernandonogueira Mar 3, 2024
29c2286
docs: remove pull request template for now
fernandonogueira Mar 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop

This file was deleted.

15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Ox - MongoDB Database Versioning and Migration Tool
===================

[![Build Status][travis-badge]][travis-url] [![Code Coverage][codecov-badge]][codecov-url] [![Artifacts][jitpack-badge]][jitpack-url]
[![Build Status][build-badge]][build-badge-url] [![Code Coverage][codecov-badge]][codecov-url] [![Artifacts][jitpack-badge]][jitpack-url]

## Description
Schemaless doesn't mean no schema!
Expand All @@ -26,6 +26,11 @@ This project simplifies that.

Compatible with Java 17+ and MongoDB 2.6 to 7.x.

## Docs
Check the [Ox's documentation](http://ox.readthedocs.io/en/latest/)

You can also check the demo project [here](https://github.com/fernandonogueira/ox-example)

## Installation

### Maven
Expand Down Expand Up @@ -110,10 +115,6 @@ public void myMethod(){

```

## Docs

See Ox's docs here: http://ox.readthedocs.io/en/latest/

## Requirements

- Java 17
Expand Down Expand Up @@ -151,7 +152,7 @@ SOFTWARE.

[codecov-badge]: https://codecov.io/gh/fernandonogueira/Ox/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/fernandonogueira/Ox
[travis-badge]: https://travis-ci.org/fernandonogueira/Ox.svg?branch=master
[travis-url]: https://travis-ci.org/fernandonogueira/Ox
[build-badge]: https://github.com/fernandonogueira/Ox/workflows/Test/badge.svg
[build-badge-url]: https://github.com/fernandonogueira/Ox
[jitpack-badge]: https://jitpack.io/v/fernandonogueira/Ox.svg
[jitpack-url]: https://jitpack.io/#fernandonogueira/Ox
Loading