Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
* Added example code snippets
* Added a few document entries
* Added a demo of the CLI use
* Updated the version
  • Loading branch information
habedi committed Oct 21, 2024
1 parent 8b5b783 commit a12e6c2
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,4 @@ poetry.lock
*.gz
*.xlsx
*.zip
*.cast
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Mongo Analyser

<img src="assets/logo_v1.png" align="right" width="25%"/>
<img src="assets/logo-v1.png" align="right" width="25%"/>

[![Tests](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/habedi/mongo-analyser/graph/badge.svg?token=HOTAZKP3V7)](https://codecov.io/gh/habedi/mongo-analyser)
Expand Down Expand Up @@ -39,3 +39,7 @@ After the installation is complete, you can use the `mongo-analyser` command in

See the [documentation](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md) for more information and
examples.

## Demo

[![asciicast](https://asciinema.org/a/682346.svg)](https://asciinema.org/a/682346)
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "mongo-analyser"
version = "0.1.4"
version = "0.1.5"
description = "A minimalistic tool for analysing and extracting the schema of a MongoDB collection."
authors = ["Hassan Abedi <[email protected]>"]
maintainers = ["Hassan Abedi <[email protected]>"]
Expand Down

0 comments on commit a12e6c2

Please sign in to comment.