Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thkruz authored Jan 13, 2021
1 parent 4733b06 commit b774337
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@
**ootk** is a modular collection of small libraries for doing math related to orbital objects written in TypeScript. ootk was developed to simplify the math and let you focus on using the results.

## Table of Contents
## :blue_book: Table of Contents
- [Installation](#Installation)
- [Usage](#Usage)
- [Contributing](#Contributing)
- [Building](#Building)
- [Contributors](#Contributors)
- [License](#License)

## Installation
## :wrench: Installation

Install the library with [NPM](https://www.npmjs.com/):

```bash
npm i ootk
```

## Usage
## :satellite: Usage

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

Expand Down Expand Up @@ -53,7 +53,7 @@ Include `dist/ootk.min.js` as a script in your html:
var satrec = Ootk.Sgp4.createSatrec(line1, line2, 'wgs72', 'i');
```

## Building
## :desktop_computer: Building

The source code is organized as Common.js modules and uses [ES6 syntax](http://es6-features.org/). To build the library:

Expand All @@ -71,7 +71,7 @@ The source code is organized as Common.js modules and uses [ES6 syntax](http://e
npm run build:umd
```

## NPM Scripts
## :gem: NPM Scripts

- `build` compiles TypeScript into ES6 Modules
- `build:umd` compiles TypeScript into ES6 Modules and generates UMD files
Expand All @@ -81,7 +81,7 @@ The source code is organized as Common.js modules and uses [ES6 syntax](http://e
- `test` runs jest to verify code remains functional
- `test:coverage` generates lcov report to view code coverage

## Contributing
## :man_teacher: Contributing

This repo follows [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).

Expand Down Expand Up @@ -113,7 +113,7 @@ git add .
git cz
```
## Contributors
## :man_scientist: Contributors
This whole project is an example of standing on the shoulder's of giants. None of it would have been possible without the previous work of the following:

Expand All @@ -123,6 +123,6 @@ This whole project is an example of standing on the shoulder's of giants. None o
- [brandon-rhodes (Brandon Rhodes)](https://github.com/brandon-rhodes)


## License
## :balance_scale: License

In keeping with the tradition of [Shashwat Kandadai's satellite.js](https://github.com/shashwatak/satellite-js/) and [Brandon Rhodes' sgp4](https://pypi.python.org/pypi/sgp4/), I kept this licensed under the [MIT License](LICENSE.md).

0 comments on commit b774337

Please sign in to comment.