You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Contributing to Xencoding
1
+
# Contributing to @lexicographic/keys
2
2
3
-
Thank you for considering a contribution to Xencoding! Pull requests, issues and comments are welcome. For pull requests, please:
3
+
Thank you for considering a contribution to `@lexicographic/keys`! Pull requests, issues and comments are welcome. For pull requests, please:
4
4
5
5
* Add tests for new features and bug fixes
6
6
* Follow the existing style
@@ -15,4 +15,4 @@ Atlassian requires contributors to sign a Contributor License Agreement, known a
15
15
Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual.
16
16
17
17
*[CLA for corporate contributors](https://opensource.atlassian.com/corporate)
18
-
*[CLA for individuals](https://opensource.atlassian.com/individual)
18
+
*[CLA for individuals](https://opensource.atlassian.com/individual)
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.
5
+
`@lexicographic/keys` 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.
6
6
7
7
## Key Features
8
8
@@ -12,9 +12,9 @@ Xencoding is a lexicographical encoding library that converts mixed-type data (s
12
12
-**Type Safety**: Full TypeScript support with comprehensive type definitions
13
13
-**Zero Dependencies**: Lightweight pure JavaScript implementation
14
14
15
-
## Why Xencoding?
15
+
## Why `@lexicographic/keys`?
16
16
17
-
Xencoding offers several advantages over alternative encoding libraries like [charwise](https://github.com/dominictarr/charwise):
17
+
`@lexicographic/keys` offers several advantages over alternative encoding libraries like [charwise](https://github.com/dominictarr/charwise):
18
18
19
19
-**Human-Readable Output**: Generated keys are a lot more readable
20
20
-**Proper Integer Handling**: Treats integers as integers rather than converting them to floats, preserving precision and natural sorting
@@ -26,7 +26,7 @@ Xencoding offers several advantages over alternative encoding libraries like [ch
0 commit comments