Skip to content

Commit caae971

Browse files
committed
Cleanup
1 parent 78c4e99 commit caae971

4 files changed

Lines changed: 4 additions & 98 deletions

File tree

.DS_Store

-6 KB
Binary file not shown.

.github/workflows/README.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![npm version](https://img.shields.io/npm/v/@atlassian/xencoding.svg?style=flat-square)](https://www.npmjs.com/package/@atlassian/xencoding) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
44

5-
Xencoding is a lexicographical encoding library that converts mixed-type data (strings and numbers) into sortable string keys. This enables efficient range queries and prefix matching in key-value stores, databases, and other systems that rely on lexicographical ordering.
5+
Xencoding is a lexicographical encoding library that converts mixed-type data (strings and numbers) into sortable string keys. This enables efficient range queries and prefix matching in key-value stores\databases (i.e DynamoDB), and other systems that rely on lexicographical ordering.
66

77
## Key Features
88

@@ -14,7 +14,7 @@ Xencoding is a lexicographical encoding library that converts mixed-type data (s
1414

1515
## Why Xencoding?
1616

17-
Xencoding offers several advantages over alternative encoding libraries like [https://github.com/dominictarr/charwise](charwise):
17+
Xencoding offers several advantages over alternative encoding libraries like [charwise](https://github.com/dominictarr/charwise):
1818

1919
- **Human-Readable Output**: Generated keys are a lot more readable
2020
- **Proper Integer Handling**: Treats integers as integers rather than converting them to floats, preserving precision and natural sorting
@@ -172,12 +172,6 @@ Run the test suite:
172172
yarn test
173173
```
174174

175-
Or with npm:
176-
177-
```bash
178-
npm test
179-
```
180-
181175
The library includes comprehensive tests covering:
182176

183177
- Basic encoding/decoding functionality

tsconfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@
4141
"skipLibCheck": false,
4242

4343
"erasableSyntaxOnly": true
44-
}
44+
},
45+
"include": ["./src/**/*.ts"]
4546
}

0 commit comments

Comments
 (0)