Added readme

README.md

@@ -0,0 +1,10 @@
+# `@staratlas/stv`
+A library for verifying vote results, released by the Star Atlas DAO.
+
+## Purpose
+This library allows users to verify vote results that have occurred within the Star Atlas DAO. It provides a way to ensure transparency and accountability in the voting process.
+
+## Key Functionality
+
+### `calculateStvWinners`
+The main interaction function provided by this library, which calculates the winners of votes using the [Single Transferable Vote (STV) method](https://en.wikipedia.org/wiki/Single_transferable_vote).

package.json

@@ -1,4 +1,7 @@
 {
+  "name": "@staratlas/stv",
+  "version": "0.0.0",
+  "description": "STV vote code for the Star Atlas DAO",
   "scripts": {
     "build": "pnpm run -r build",
     "watch": "pnpm build && pnpm run -r --parallel watch",

packages/stv/src/index.test.ts

@@ -187,7 +187,7 @@ describe('calculateStvWinners', () => {
   //       { voteCount: 1, voteOrder: ['Dave', 'Eve'] },
   //       { voteCount: 1, voteOrder: ['Eve', 'Dave'] },
   //     ];
-
+  //
   //     const { winners, tieCount } = calculateStvWinners(voteRecords, 3);
   //     console.log(winners);
   //     expect(winners.length).toBe(5);