Skip to content

Commit

Permalink
docs: add README.md information
Browse files Browse the repository at this point in the history
  • Loading branch information
mdsanima committed Aug 12, 2021
1 parent 6c5b560 commit 2efd757
Showing 1 changed file with 74 additions and 20 deletions.
94 changes: 74 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,98 @@
# mdsanima-dev

This is a **MDSANIMA-DEV** developer page. Here you can find various python
This is a **mdsanima-dev** developer page. Here you can find various python
packages. So let me show something.

## Python Package `mdsanima_dev`

### Module `colors`
This Python Pacage developed by Marcin Różewski aka
[MDSANIM](https://mdsanima.com) includes several useful modules thats he uses
in various projects.

#### Function `complex_color`
## Installation

#### Function `show_complex_color`
Instructions how to install the package.

#### Function `get_complex_color`
### Using PyPi

### Module `emoji`
Install latest version:

#### Function `emoji_get_url_data`
```shell
python3 -m pip install mdsanima_dev
```

#### Function `emoji_clean_url_data`
Install specific version:

#### Function `emoji_load_json_data`
```shell
python3 -m pip install mdsanima_dev==0.1.0
```

#### Class `emoji`
Upgrade pacage to latest version:

#### Calss `show`
```shell
python3 -m pip install --upgrade mdsanima_dev
python3 -m pip install --force-reinstall msdsanima_dev
```

### Module `table`
Uninstall pacage:

#### Class `table`
```shell
python3 -m pip uninstall mdsanima_dev
```

#### Class `table_elem`
### Using Setup

### Module `tools`
```shell
git clone https://github.com/mdsanima-dev/mdsanima-dev
cd mdsanima-dev
python3 setup.py install
```

#### Function `read_file`
## Develempent

#### Function `append_file`
Help instruction for development.

#### Function `get_response_json`
### Build documentation

#### Function `machine`
```shell
sudo python3 setup.py install build_sphinx
```

#### Class `progress`
### Automation Release

Add a `standard-version` npm pacage to automatically create `CHANGELOG.md`
and tracking version. This option allow to generate automatically changelog
file for the project and tracking version on the `mdsanima_dev` based on commit
messages.

For some reason thats features is only for the development not allow and accecs
for the `mdsanima_dev` Python Pacage.

Make release run in the console:

```shell
standard-version release
```

For checking if everything is ok:

```shell
standard-version release-test
```

## Connect With Me

Hi there, I'm Marcin Różewski aka [MDSANIMA](https://mdsanima.com).
These are my social media, check it out please. Thanks.

![GitHub followers](https://img.shields.io/github/followers/mdsanima?style=social)
![Twitter Follow](https://img.shields.io/twitter/follow/toudajew?style=flat-square)
![Twitter Follow](https://img.shields.io/twitter/follow/str9led?style=flat-square)
![Twitter Follow](https://img.shields.io/twitter/follow/mdsanima?style=flat-square)
![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCB5na2BRwrnwx00LCspbG5Q?style=social)
![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCB5na2BRwrnwx00LCspbG5Q?style=social)

## License

Python Pacage `mdsanima_dev` is released under the terms of
[MIT License](https://github.com/mdsanima-dev/mdsanima-dev/blob/master/LICENSE)

0 comments on commit 2efd757

Please sign in to comment.