Skip to content

Commit

Permalink
format: Apply Markdownlint to plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
dmohns committed Mar 15, 2024
1 parent 2a2e917 commit 1dd777f
Show file tree
Hide file tree
Showing 18 changed files with 91 additions and 131 deletions.
5 changes: 2 additions & 3 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ globs:
- "**/*.md"

ignores:
- Website/ui/src/docs/source/index.md
- Website/ui/src/docs/source/.compare.md
- Website/htdocs/mpmanager/packages/
- "**/node_modules/**"
- "**/vendor/**"
4 changes: 2 additions & 2 deletions Website/htdocs/mpmanager/.editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ trim_trailing_whitespace = true
indent_size = 2

[*.md]
trim_trailing_whitespace = false
indent_size = 2

[*.yml]
[*.{yml,yaml}]
indent_style = space
indent_size = 2
16 changes: 6 additions & 10 deletions Website/htdocs/mpmanager/packages/inensus/angaza-shs/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
## Package-Development-Starter-Pack

#### Starter pack for package development to MicroPowerManager.

- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage


### Starter pack for package development to MicroPowerManager


- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
## Customer Registration with Csv

11 changes: 5 additions & 6 deletions Website/htdocs/mpmanager/packages/inensus/calin-meter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ This plugin integrates **Calin meters** to Micropowermanager. It uses `user_id`

## Sms Sending

This plugin use Micropowermanager's Sms-Gateway application for notifying customers.

This plugin use Micropowermanager's Sms-Gateway application for notifying customers.

## Installation

Install the package via `composer require inensus/calin-meter`

After the package is downloaded run `php artisan calin-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.

After the package is downloaded run `php artisan calin-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ This plugin integrates Calin meters to Micropowermanager. It uses company_name,

This plugin use Micropowermanager's Sms-Gateway application for notifying customers.


## Installation

Install the package via `composer require inensus/calin-smart-meter`

After the package is downloaded run `php artisan calin-smart-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.

After the package is downloaded run `php artisan calin-smart-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.
16 changes: 6 additions & 10 deletions Website/htdocs/mpmanager/packages/inensus/daly-bms/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
## Package-Development-Starter-Pack

#### Starter pack for package development to MicroPowerManager.

- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage


### Starter pack for package development to MicroPowerManager


- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
## Package-Development-Starter-Pack

#### Starter pack for package development to MicroPowerManager.

- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage


### Starter pack for package development to MicroPowerManager


- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
16 changes: 6 additions & 10 deletions Website/htdocs/mpmanager/packages/inensus/kelin-meter/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
## Package-Development-Starter-Pack

#### Starter pack for package development to MicroPowerManager.

- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage


### Starter pack for package development to MicroPowerManager


- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
Original file line number Diff line number Diff line change
@@ -1,30 +1,28 @@
## MeSomb Payment Provider
#### Payment provider package for getting payments to MicroPowerManager.

### Payment provider package for getting payments to MicroPowerManager

This plugin created for getting MeSomb payments into MicroPowerManager.

## Installation

Install the package via `composer require inensus/mesomb-payment-provider`

After the package is downloaded run `php artisan mesomb-payment-provider:install` command.

## Note
To get payments with use this package from MeSomb, you have to log in `https://mesomb.hachther.com/`

To get payments with use this package from MeSomb, you have to log in `https://mesomb.hachther.com/`
and follow these steps bellow;

### step 1

Go to the list of your services (in “My Applications”) and click on the name or the “View” button of your service

### step 2

On the detail page, click on the cog icon then on “Webhook”

### step 3
Fill the webhook link field is as `http://yourdomain.com/api/mesomb`.







Fill the webhook link field is as `http://yourdomain.com/api/mesomb`.
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
## Package-Development-Starter-Pack

#### Starter pack for package development to MicroPowerManager.

- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage


### Starter pack for package development to MicroPowerManager


- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
18 changes: 8 additions & 10 deletions Website/htdocs/mpmanager/packages/inensus/spark-meter/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
# SparkMeter API integration

This plugin uses **KoiosAPI** for the main authentication.
This plugin uses **KoiosAPI** for the main authentication.
After it got authenticated it uses the **ThunderCloud API** for basic CRUD operations.

You need to enter the **ThunderCloud Token** on the site levels.
You need to enter the **ThunderCloud Token** on the site levels.

Koios access gives us the ability to synchronize the elder transactions( or the transaction that are not processed over Micropowermanager).

## Sms Sending
This plugin use Micropowermanager's Sms-Gateway application for notifying customers.
When their account balances reduce under their low balance warning limit and when customers make new payments, notifies through sms.

This plugin use Micropowermanager's Sms-Gateway application for notifying customers.
When their account balances reduce under their low balance warning limit and when customers make new payments, notifies through sms.

## Installation

Install the package via `composer require inensus/spark-meter`

After the package is downloaded run `php artisan spark-meter:install` command.
After the package is downloaded run `php artisan spark-meter:install` command.

This command will also publish its own
vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.



vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.
14 changes: 7 additions & 7 deletions Website/htdocs/mpmanager/packages/inensus/steama-meter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
Steamaco API integration for Micropowermanager

This plugin integrates **Steamaco meters** to Micropowermanager. It uses the same credentials as **ui.steama.co** for authentication.
After it got authenticated, the plugin synchronizes Site, Customer, Meter and Agent records from **steama.co**.
After it got authenticated, the plugin synchronizes Site, Customer, Meter and Agent records from **steama.co**.

When all records been updated, the plugin will start to synchronize the elder transactions( or the transaction that are not processed over Micropowermanager) automatically.

## Sms Sending

This plugin use Micropowermanager's Sms-Gateway application for notifying customers.
This plugin use Micropowermanager's Sms-Gateway application for notifying customers.
When their account balances reduce under their low balance warning limit and when customers make new payments, notifies through sms.

## Installation

Install the package via `composer require inensus/steama-meter`

After the package is downloaded run `php artisan steama-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.

After the package is downloaded run `php artisan steama-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.
11 changes: 5 additions & 6 deletions Website/htdocs/mpmanager/packages/inensus/stron-meter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ This plugin integrates **Stron meters** to Micropowermanager. It uses the api lo

## Sms Sending

This plugin use Micropowermanager's Sms-Gateway application for notifying customers.

This plugin use Micropowermanager's Sms-Gateway application for notifying customers.

## Installation

Install the package via `composer require inensus/stron-meter`

After the package is downloaded run `php artisan stron-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.

After the package is downloaded run `php artisan stron-meter:install` command.
This command will also publish its own vue files into the main project.
That means you need to run either `npm run production` manually or `docker-compose up node` if you're using the dockerized version.
16 changes: 6 additions & 10 deletions Website/htdocs/mpmanager/packages/inensus/sun-king-shs/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
## Package-Development-Starter-Pack

#### Starter pack for package development to MicroPowerManager.

- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage


### Starter pack for package development to MicroPowerManager


- This repo has created by the MicroPowerManager development team for developers who will develop a new package for MicroPowerManager.
- The team suggests developers use this repo when they decide to develop new packages to MicroPowerManager.
- Developers should clone our `Core` project with this url `https://github.com/inensus/MPManager` first. After cloning and running the core project, They have to go into laravel container and navigate to mpmanager & run `php artisan micropowermanager:new-package {{package-name}}` command to clone `this repo` into packages folder in MicroPowerManager core project.
- After cloning Package-Development-Starter-Pack, developers can keep developing the package inside of core project.
- When the developing will have been finished they can upload their packages to `https://packagist.org/` for the other developers usage
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
## Swifta Payment Provider

#### Payment provider package for getting payments to MicroPowerManager.
### Payment provider package for getting payments to MicroPowerManager

This plugin created for getting Swifta payments into MicroPowerManager.

## Installation

Install the package via `composer require inensus/swifta-payment-provider`

After the package is downloaded run `php artisan swifta-payment-provider:install` command.
Loading

0 comments on commit 1dd777f

Please sign in to comment.