Skip to content

Commit dd3c03e

Browse files
committed
Renamed and standardized README
1 parent 2dbb835 commit dd3c03e

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README.mkdn renamed to README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
1-
## MATLAB PLOTLY API WRAPPER 2.2.8
1+
# MATLAB
22

3-
### INSTALLATION:
3+
> MATLAB Online Toolbox - Create interactive charts in your web browser with MATLAB and Plotly
44
5-
The lastest version of the wrapper can be downloaded [here](https://github.com/plotly/MATLAB-Online/archive/master.zip).
5+
Version: 2.2.8
66

7-
Once downloaded, run `plotlysetup('your_username', 'your_api_key')` to get started.
7+
## Install
88

9-
### UPDATES:
9+
The latest version of the wrapper can be downloaded [here](https://github.com/plotly/MATLAB-Online/archive/master.zip).
1010

11-
**NOTE:** `plotlyupdate.m` is currently disabled.
11+
Once downloaded, run `plotlysetup('your_username', 'your_api_key')` to get started.
1212

13-
Please manually download and setup the latest version
14-
of the wrapper by following the installation instructions above.
13+
### Updates
1514

16-
### NUTSHELL:
15+
**NOTE:** `plotlyupdate.m` is currently turned off.
16+
17+
Please manually download and setup the latest version
18+
of the wrapper by following the installation instructions above.
19+
20+
## Usage
1721

1822
Convert your MATLAB figures into online [Plotly](https://plot.ly) graphs with a single line of code:
1923

@@ -57,10 +61,22 @@ and Plotly figure retrieval:
5761
p = getplotlyfig('chris', 1638) % downloads the graph data from https://plot.ly/~chris/1638
5862
```
5963

60-
### DOCUMENTATION:
61-
Live here: [https://plot.ly/matlab](https://plot.ly/matlab)
64+
## Documentation
65+
66+
This lives here: [https://plot.ly/matlab](https://plot.ly/matlab)
67+
68+
## Maintainers
6269

63-
### CONTACT:
6470
- <chuck@plot.ly>
6571
- <chris@plot.ly>
6672
- [@plotlygraphs](https://twitter.com/plotlygraphs)
73+
74+
## Contribute
75+
76+
Please do! This is an open source project. Check out [the issues](https://github.com/plotly/MATLAB-Online/issues) or open a PR!
77+
78+
We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](CODE_OF_CONDUCT.md) for more information.
79+
80+
## License
81+
82+
[MIT](LICENSE) © 2017 Plotly, Inc.

0 commit comments

Comments
 (0)