mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-24 17:36:14 -04:00
checkPlugin: Redo README.md and LICENSE
This commit is contained in:
parent
d81546ad7b
commit
5915c2243d
4 changed files with 246 additions and 42 deletions
|
@ -1,30 +1,47 @@
|
|||
# My awesome plugin README example
|
||||
Explain what your plugin does and who it's useful for.
|
||||
# [plugin_name]
|
||||
|
||||
TODO: Describe the plugin.
|
||||
|
||||
## Example animated gif of usage if appropriate
|
||||
|
||||

|
||||
|
||||
## Installing
|
||||
## Installation
|
||||
|
||||
```
|
||||
From the Etherpad working directory, run:
|
||||
|
||||
```shell
|
||||
npm install --no-save --legacy-peer-deps [plugin_name]
|
||||
```
|
||||
|
||||
or Use the Etherpad ``/admin`` interface.
|
||||
Or, install from Etherpad's `/admin/plugins` page.
|
||||
|
||||
## Settings
|
||||
Document settings if any
|
||||
## Configuration
|
||||
|
||||
TODO
|
||||
|
||||
## Testing
|
||||
Document how to run backend / frontend tests.
|
||||
|
||||
### Frontend
|
||||
To run the backend tests, run the following from the Etherpad working directory:
|
||||
|
||||
Visit http://whatever/tests/frontend/ to run the frontend tests.
|
||||
```shell
|
||||
(cd src && npm test)
|
||||
```
|
||||
|
||||
### backend
|
||||
To run the frontend tests, visit: http://localhost:9001/tests/frontend/
|
||||
|
||||
Type ``cd src && npm run test`` to run the backend tests.
|
||||
## Copyright and License
|
||||
|
||||
## LICENSE
|
||||
Apache 2.0
|
||||
Copyright © [yyyy] [name of copyright owner]
|
||||
and the [plugin_name] authors and contributors
|
||||
|
||||
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License"); you
|
||||
may not use this file except in compliance with the License. You may obtain a
|
||||
copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software distributed
|
||||
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
||||
CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations under the License.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue