https://github.com/degjs/samplemodule
A sample DEGJS repository. Please clone and follow this template when creating a new module.
https://github.com/degjs/samplemodule
guide
Last synced: 4 months ago
JSON representation
A sample DEGJS repository. Please clone and follow this template when creating a new module.
- Host: GitHub
- URL: https://github.com/degjs/samplemodule
- Owner: DEGJS
- Created: 2016-06-28T16:18:16.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-01-31T03:58:13.000Z (over 9 years ago)
- Last Synced: 2025-07-24T00:24:27.191Z (11 months ago)
- Topics: guide
- Size: 1.95 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [MODULE NAME]
[MODULE INTRO TEXT]
## Install
[MODULE NAME] is an ES6 module. Consequently, you'll need an ES6 transpiler ([Babel](https://babeljs.io) is a nice one) and a module loader ([SystemJS](https://github.com/systemjs/systemjs) will do the job) as part of your Javascript workflow.
If you're already using the [JSPM package manager](http://jspm.io) for your project, you can install [MODULE NAME] with the following command:
```
$ jspm install github:DEGJS/[MODULE NAME]
```
## Usage
```js
[EXAMPLE CODE]
```
## Options
#### options.[OPTION NAME]
Type: `[OPTION TYPE]` Default: `[OPTION DEFAULT VALUE]`
[OPTION DESCRIPTION]
## Methods
### .[METHOD NAME]()
Parameters: [METHOD PARAMETERS]
[METHOD DESCRIPTION]
## Browser Support
[MODULE NAME] depends on the following browser APIs:
+ [[API NAME]]([API REFERENCE LINK])
To support legacy browsers, you'll need to include polyfills for the above APIs.