Skip to content

Commit d237abf

Browse files
author
Rafael Becerra
committed
INT-16836: Create or update Readme files for Open LMS plugins
1 parent 1356a95 commit d237abf

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# Introduction
2-
1+
# AWS SDK Local plugin
32
This plugin was contributed by the Open LMS Product Development team. Open LMS is an education technology company
43
dedicated to bringing excellent online teaching to institutions across the globe. We serve colleges and universities,
54
schools and organizations by supporting the software that educators use to manage and deliver instructional content to
65
learners in virtual classrooms.
76

87
This plugin only serves as a way to distribute the AWS SDK for PHP.
98

10-
# How to update the SDK
9+
## Installation
10+
Extract the contents of the plugin into _/wwwroot/local_ then visit `admin/upgrade.php` or use the CLI script to upgrade your site.
1111

12+
## How to update the SDK
1213
Make any necessary updates to the `composer.json` file. Usually nothing needs to change unless upgrading to the next
1314
major version. Then, from within this project, run this command:
1415

@@ -20,3 +21,18 @@ Then stage changes:
2021

2122
If everything looks good, then commit the changes. Please include SDK version in the commit message. Lastly,
2223
update the `thirdpartylibs.xml` with new versions and any new libraries.
24+
25+
## License
26+
Copyright (c) 2021 Open LMS (https://www.openlms.net)
27+
28+
This program is free software: you can redistribute it and/or modify it under
29+
the terms of the GNU General Public License as published by the Free Software
30+
Foundation, either version 3 of the License, or (at your option) any later
31+
version.
32+
33+
This program is distributed in the hope that it will be useful, but WITHOUT ANY
34+
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
35+
PARTICULAR PURPOSE. See the GNU General Public License for more details.
36+
37+
You should have received a copy of the GNU General Public License along with
38+
this program. If not, see <http://www.gnu.org/licenses/>.

0 commit comments

Comments
 (0)