Skip to content

Commit

Permalink
Merge pull request #3 from azam/develop
Browse files Browse the repository at this point in the history
Fix README
  • Loading branch information
azam committed Mar 31, 2023
2 parents ecec373 + 6a794ff commit d6c3d9a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# azamcodec-rs
# azamcodec-js

[![Build Status](https://github.com/azam/azamcodec-js/actions/workflows/build.yml/badge.svg)](https://github.com/azam/azamcodec-js/actions/workflows/build.yml)
[![npm](https://badge.fury.io/js/azamcodec.svg)](https://badge.fury.io/js/azamcodec)
[![npm](https://badge.fury.io/js/azamcodec.svg)](https://www.npmjs.com/package/azamcodec)

An encoder and decoder implementation in Javascript for [Azam Codec](https://github.com/azam/azamcodec), a lexicographically sortable multi-section base16 encoding of byte array. Zero external dependencies.

Expand All @@ -17,7 +17,7 @@ Import the module and start using it.
### Decoding

```js
import { decodeInt, decodeInts } from '@azamshul/azamcodec';
import { decodeInt, decodeInts } from 'azamcodec';

// Decode first section of Azam Codec encoded string as unsigned integer.
// "xytxvyyf" decodes to 0xdeadbeefu32, the rest of string is ignored.
Expand All @@ -33,7 +33,7 @@ let x = decodeInts('xytxvyyfh5wgg1'); // [0xdeadbeefu32, 0x15u8, c001u16]
### Encoding

```js
import { encodeInt, encodeInts } from '@azamshul/azamcodec';
import { encodeInt, encodeInts } from 'azamcodec';

// Encode unsigned integer value as Azam Codec encoded string.
// 0xdeadbeef encodes to "xytxvyyf".
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "azamcodec",
"version": "0.1.0",
"version": "0.1.1",
"description": "Encoder and decoder library for Azam Codec",
"type": "module",
"main": "src/index.js",
Expand Down

0 comments on commit d6c3d9a

Please sign in to comment.