Skip to content

Commit

Permalink
docs: Improved project's readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
JordanWelsman committed Mar 7, 2023
1 parent acb56d2 commit 34cdbe0
Showing 1 changed file with 82 additions and 0 deletions.
82 changes: 82 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,88 @@

A modular approach to parsing JSON.

------------------------------------------------------

<div align="center">

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/JordanWelsman/openjson?style=for-the-badge)](https://github.com/JordanWelsman/openjson/tags)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/JordanWelsman/openjson?style=for-the-badge)](https://github.com/JordanWelsman/openjson/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/JordanWelsman/openjson?style=for-the-badge)](https://github.com/JordanWelsman/openjson/wiki/Version-History)
[![GitHub license](https://img.shields.io/github/license/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/openjson/blob/main/LICENSE.md)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/JordanWelsman/openjson?style=for-the-badge)](https://github.com/JordanWelsman/openjson/commits/main)
<!--[![GitHub wiki](https://img.shields.io/badge/wiki-openjson-blueviolet?style=for-the-badge)](https://github.com/JordanWelsman/openjson/wiki)-->

</div>
<div align="center">

[![PyPI](https://img.shields.io/pypi/v/openjson?style=for-the-badge)](https://pypi.org/project/openjson)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/openjson?style=for-the-badge)](https://docs.python.org/3/whatsnew/3.10.html)
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/openjson?style=for-the-badge)](https://pypi.org/project/nexport/#files)
[![PyPI - Status](https://img.shields.io/pypi/status/openjson?style=for-the-badge)](https://pypi.org/project/openjson/#data)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/openjson?style=for-the-badge)](https://pypi.org/project/openjson/#history)

</div>
<div align="center">

[![GitHub Repo stars](https://img.shields.io/github/stars/JordanWelsman/openjson?style=for-the-badge)](https://github.com/JordanWelsman/openjson/stargazers)
[![GitHub watchers](https://img.shields.io/github/watchers/JordanWelsman/openjson?style=for-the-badge)](https://github.com/JordanWelsman/openjson/watchers)
[![GitHub forks](https://img.shields.io/github/forks/JordanWelsman/openjson?style=for-the-badge)](https://github.com/JordanWelsman/openjson/network/members)
![Lines of code](https://img.shields.io/tokei/lines/github/JordanWelsman/openjson?style=for-the-badge)
![GitHub repo file count](https://img.shields.io/github/directory-file-count/JordanWelsman/openjson?style=for-the-badge)
![GitHub repo size](https://img.shields.io/github/repo-size/JordanWelsman/openjson?style=for-the-badge)

</div>

## Overview

_openjson_ is a Python package that provides functionality for parsing JSON with a modular inplementation. You can pass a dictionary to be stringified, serialized, or exported into JSON. The dictionary can contain any structure of intrinsic types including dictionaries, arrays, strings, integers and floats.

## Table of contents

- [openjson](#openjson)
- [Overview](#overview)
- [Table of contents](#table-of-contents)
- [Install \& use](#install--use)
- [Roadmap](#roadmap)
- [Credits](#credits)
- [Licence](#licence)
- [Links](#links)

## Install & use

1. From terminal: `pip install openjson`
2. From python environment: `from openjson import <submodule>` where `<submodule>` is one from the following:

- `stringify`
- `serialize`
- `deserialize`
- `parse`

## Roadmap

- [x] JSON Stringify
- [ ] JSON Serialize
- [ ] JSON Deserialize
- [ ] JSON Parse

## Credits

openjson was created and is currently maintained by **Jordan Welsman**.

## Licence

openjson_ is developed and distributed under the `MIT` license.
> **Note**
> See `LICENSE` for more details.
## Links

:file_folder: [See this project on GitHub](https://github.com/JordanWelsman/openjson)

:gift: [See this project on PyPI](https://pypi.org/project/openjson/)

:cat: [Follow me on GitHub](https://github.com/JordanWelsman/)

:briefcase: [Connect with me on Linkedin](https://linkedin.com/in/JordanWelsman/)

:email: [Send me an email](mailto:[email protected])

0 comments on commit 34cdbe0

Please sign in to comment.