Skip to content

Commit

Permalink
docs: add example repository to readme (#21)
Browse files Browse the repository at this point in the history
* docs: add example repository to readme
* docs: remove pull request template for now
  • Loading branch information
fernandonogueira authored Mar 3, 2024
1 parent 080f6d7 commit c9abe5c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 24 deletions.
17 changes: 0 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

15 changes: 8 additions & 7 deletions README.md
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

0 comments on commit c9abe5c

Please sign in to comment.