Skip to content

Commit

Permalink
Add more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TheAnnalyst authored Nov 25, 2020
1 parent d541217 commit 59997cf
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

A TypeScript library for handling FRC scouting data from robotics tournaments.

Currently, it only supports Deep Space, but Infinite Recharge is a future goal.

## Example
```ts
import {SQLBackend, DeepSpace, Team} from 'frc-scouting';
Expand All @@ -17,12 +19,12 @@ const myScoutedMatch = new DeepSpace.DeepSpaceMatch(
5940, 'match', 1, 'RED', {initialHABLevel: 1, cargo, finalHABLevel: 3, bonusPoints: 12}
);

console.log(myScoutedMatch.points); //
console.log(myScoutedMatch.points); // 48

const myTeam = new Team(5940);
myTeam.addMatches(myScoutedMatch);

console.log(myTeam.getMean('points')); //
console.log(myTeam.getMean('points')); // 48

const sqlPlan = new DeepSpace.DeepSpaceSQL(':memory:');
const storage = new SQLBackend(sqlPlan);
Expand All @@ -33,3 +35,4 @@ console.log(myTeamLoaded?.getMean('points'));
```

## Documentation
More detailed documentation can found [here](https://github.com/TheAnnalyst/frc-scouting/blob/main/docs/modules/_index_.md).

0 comments on commit 59997cf

Please sign in to comment.