Skip to content

Commit

Permalink
docs: add motivation and missing informations
Browse files Browse the repository at this point in the history
  • Loading branch information
theodrosyimer committed Feb 25, 2024
1 parent e098c16 commit 04a1d3c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
## Motivation

`binez` was born out of that frustration. It's a simple command line tool that can do the following:
I was working on a project where I had to calculate the range of a given number of bits and the size limit of a given number of bits in a given memory size in kilobytes. I found myself constantly having to do the same calculations over and over again and I was getting frustrated. So,`binez` was born out of that frustration. It's a simple command line tool that can do the following:

- convert a given number in megabytes to bytes (e.g. 1MB to 1_048_576 bytes)
- calculate the range of a given number of bits (e.g. for an unsigned 8 bits, the range is 0-255)
Expand Down Expand Up @@ -65,13 +65,13 @@ Convert 6MB to bytes:
binez convert 6
```

Calculate the range of a given number of unsigned bits:
Calculate the range of a given number of unsigned bits (default):

```sh
binez range -b 8
```

Calculate the range of a given number of unsigned bytes:
Calculate the range of a given number of unsigned bytes (default):

```sh
binez range -B 2
Expand Down

0 comments on commit 04a1d3c

Please sign in to comment.