Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitriim committed Nov 12, 2023
1 parent 3f01383 commit fc6fe77
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 7 deletions.
46 changes: 40 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
<a href="https://github.com/dmitriim/moodle-block_verify_certs/actions/workflows/ci.yml?query=branch%3AMOODLE_401_STABLE">
<img src="https://github.com/dmitriim/moodle-block_verify_certs/workflows/ci/badge.svg?branch=MOODLE_401_STABLE">
</a>
<a href="https://github.com/dmitriim/moodle-block_verify_certs/actions"><img src="https://github.com/dmitriim/moodle-block_verify_certs/workflows/ci/badge.svg"></a>

# Verify certificates #
# Block Verify certificates #

TODO Describe the plugin shortly here.
The block allows to verify all certificates installed in your Moodle using a single form.

**Note**: This is different to existing [Verify Certificate Block](https://moodle.org/plugins/block_verify_certificate)

## Build-in supported certificates ##

* Course certificate ([mod_coursecertificate](https://moodle.org/plugins/mod_coursecertificate))
* Custom certificate ([mod_customcert](https://moodle.org/plugins/mod_customcert))

TODO Provide more detailed description here.

## Installing via uploaded ZIP file ##

Expand All @@ -31,6 +35,36 @@ Alternatively, you can run

to complete the installation from the command line.

## Configuration

Navigate to **Site administration > Blocks > Verify certificates** to configure the block.


## Capabilities
Users must have **View a verify certificates block (block/verify_certs:view)** capability to use this block.

By default, this capability is granted to Authenticated user role.


## Extending support for custom certificates

Any plugin can easily implement a support for any other certificates by adding classes in the `local\block_verify_certs\certificates` namespace. Each certificate must extend the [base class](classes/local/block_verify_certs/certificates/base.php). As an example, block itself provides some certificates; the directory structure is as follows:


```
block_verify_certs
└── classes
   └── local
   └── block_verify_certs
    └── certificates
     ├── mod_coursecertificate.php
     └── mod_customcert.php
```

## Warm thanks

Thanks to **Terri Roshell (TN Fire Training Online)** for funding the development of this plugin.

## License ##

2023 Dmitrii Metelkin <[email protected]>
Expand Down
2 changes: 1 addition & 1 deletion lang/en/block_verify_certs.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@
$string['verifycertificates'] = 'Verify certificates';
$string['verify_certs:addinstance'] = 'Add a verify certificates block';
$string['verify_certs:myaddinstance'] = 'Add a new a verify certificates block to Dashboard';
$string['verify_certs:view'] = 'View a verify certificates block ';
$string['verify_certs:view'] = 'View a verify certificates block';

0 comments on commit fc6fe77

Please sign in to comment.