Skip to content

Commit 31913d0

Browse files
committed
docs(readme): updated readme notes
1 parent e85a8c2 commit 31913d0

1 file changed

Lines changed: 9 additions & 17 deletions

File tree

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,25 @@
1818
Install the library with [NPM](https://www.npmjs.com/):
1919

2020
```bash
21-
npm install ootk
21+
npm i ootk
2222
```
2323

2424
## Usage
2525

2626
### Common.js ([Node.js](https://nodejs.org))
2727

2828
```js
29-
var ootk = require('ootk.js');
29+
let Ootk = require('ootk.js');
3030
...
31-
var positionAndVelocity = ootk.Sgp4.propagate(satrec, time);
31+
const satrec = Ootk.Sgp4.createSatrec(line1, line2, 'wgs72', 'i');
3232
```
3333

3434
### ES ([Babel.js](https://babeljs.io/))
3535

3636
```js
3737
import { ootk } from 'ootk.es.js';
3838
...
39-
const positionAndVelocity = ootk.Sgp4.propagate(satrec, time);
39+
const satrec = Ootk.Sgp4.createSatrec(line1, line2, 'wgs72', 'i');
4040
```
4141

4242
### Script tag
@@ -47,10 +47,10 @@ Include `dist/ootk.min.js` as a script in your html:
4747
<script src="path/to/dist/ootk.min.js"></script>
4848
```
4949

50-
`ootk` object will be available in global scope:
50+
`Ootk` object will be available in global scope:
5151

5252
```js
53-
var positionAndVelocity = ootk.Sgp4.propagate(satrec, time);
53+
var satrec = Ootk.Sgp4.createSatrec(line1, line2, 'wgs72', 'i');
5454
```
5555

5656
## Building
@@ -109,6 +109,7 @@ npm run lint
109109
Use [commitzen](https://github.com/commitizen/cz-cli) to format your commit messages:
110110
111111
```bash
112+
git add .
112113
git cz
113114
```
114115
@@ -119,17 +120,8 @@ This whole project is an example of standing on the shoulder's of giants. None o
119120
- [ezze (Dmitriy Pushkov)](https://github.com/ezze)
120121
- [davidcalhoun (David Calhoun)](https://github.com/davidcalhoun)
121122
- [shashwatak (Shashwat Kandadai)](https://github.com/shashwatak)
122-
- [tikhonovits (Nikos Sagias)](https://github.com/tikhonovits)
123-
- [dangodev (Drew Powers)](https://github.com/dangodev)
124-
- [bakercp (Christopher Baker)](https://github.com/bakercp)
125-
- [kylegmaxwell (Kyle G. Maxwell)](https://github.com/kylegmaxwell)
126-
- [iamthechad (Chad Johnston)](https://github.com/iamthechad)
127-
- [drom (Aliaksei Chapyzhenka)](https://github.com/drom)
128-
- [PeterDaveHello (Peter Dave Hello)](https://github.com/PeterDaveHello)
129-
- [Alesha72003](https://github.com/Alesha72003)
130-
- [nhamer](https://github.com/nhamer)
131-
- [owntheweb](https://github.com/owntheweb)
132-
- [Zigone](https://github.com/Zigone)
123+
- [brandon-rhodes (Brandon Rhodes)](https://github.com/brandon-rhodes)
124+
133125

134126
## License
135127

0 commit comments

Comments
 (0)