crewtimer-common 1.0.15 → 1.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -23
- package/dist/cjs/src/types/Event.d.ts +0 -1
- package/dist/esm/src/types/Event.d.ts +0 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,31 +1,12 @@
|
|
|
1
1
|
# CrewTimer Types and Utilities
|
|
2
2
|
|
|
3
|
-
This repository includes types and utilities that are shared among various CrewTimer subsystems.
|
|
3
|
+
This repository includes types and utilities that are shared among various CrewTimer subsystems. CrewTimer grew slowly over time with nearly all the code currently written in Typescript. As a result there are inconsistencies and overlap between types that may not be good design choices but reflect current implementations.
|
|
4
4
|
|
|
5
5
|
As time allows, this codebase will be cleaned and documented but these initial versions are put out there as-is to facilite migration of addtional CrewTimer modules to open source.
|
|
6
6
|
|
|
7
|
-
## CrewTimer Repositories
|
|
8
|
-
|
|
9
|
-
### Currently Open Source
|
|
10
|
-
|
|
11
|
-
* [crewtimer-common](https://github.com/crewtimer/crewtimer-common) - Common types and utilities for CrewTimer.
|
|
12
|
-
* [crewtimer-points](https://github.com/crewtimer/crewtimer-points) - A points engine for CrewTimer results.
|
|
13
|
-
|
|
14
|
-
### Coming Soon
|
|
15
|
-
|
|
16
|
-
* crewtimer-handicaps - A handicap engine for CrewTimer handicap calculations
|
|
17
|
-
* crewtimer-connect - Support for FinishLynx integration with CrewTimer and video review of placements.
|
|
18
|
-
|
|
19
|
-
### Future Open Source
|
|
20
|
-
|
|
21
|
-
* crewtimer-mobile - Mobile Apps for Andriod and iOS
|
|
22
|
-
* crewtimer-results - CrewTimer results website [https://crewtimer.com](https://crewtimer.com)
|
|
23
|
-
* crewtimer-admin - CrewTimer Admin interface [https://admin.crewtimer.com](https://admin.crewtimer.com)
|
|
24
|
-
* crewtimer-wisblock - Hardware devices such as the BLE Clicker and Mobile Horn (C++)
|
|
25
|
-
|
|
26
7
|
## Publishing a new npm version (maintainers only)
|
|
27
8
|
|
|
28
9
|
1. Update the version in package.json
|
|
29
|
-
2. First check for any errors by running
|
|
30
|
-
3.
|
|
31
|
-
4. If no errors:
|
|
10
|
+
2. First check for any errors by running `yarn prepublishOnly`
|
|
11
|
+
3. `npm login` as crewtimer
|
|
12
|
+
4. If no errors: `npm publish`
|