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.

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

Microjson light doc #18

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

bengtl
Copy link
Member

@bengtl bengtl commented Aug 15, 2024

No description provided.

Copy link
Member

@hamshkhawar hamshkhawar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bengtl I reviewed it and suggested to make some changes.

README.md Outdated

To install MicroJSON, you can use the following command:

```pip install microjson```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

improve the visiblity of the bash command

pip install microjson

Please do see the command in the edit mode

README.md Outdated
```pip install microjson```
This will install the default version of MicroJSON with the basic functionalities and minimal dependencies. If you want to use the additional functionalities, such as provided by the ```utils``` module, you can install the package with the following command:

```pip install microjson[all]```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do the same as I suggested above

README.md Outdated

```pip install microjson[all]```


## Usage

MicroJSON can be used with any application or tool that can process JSON data. Due to its design, it is particularly suited to applications related to the analysis, visualization, and manipulation of microscopy images.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be rewritten if you want
MicroJSON is compatible with any application or tool that process JSON data. Its design makes it especially well-suited for applications involving analysis, visualization, and manipulation of microscopy images

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants