Skip to content

Commit 09dae21

Browse files
committed
docs: Cleanup readme
1 parent c936e09 commit 09dae21

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# bash-object
22

3-
The _first_ Bash library for imperatively constructing heterogeneously hierarchical data structures
3+
The _first_ Bash library for imperatively constructing data of nested and heterogeneous form
44

55
This is meant to be a low level API providing primitives for other libraries.
66

7-
In the coming days, I will release never seen before parsers written in Bash called [bash-toml](https://github.com/hyperupcall/bash-toml) and [bash-json](https://github.com/hyperupcall/bash-json) that use this library
8-
97
## Exhibition
108

119
```sh
12-
# How to represent the following in Bash?
10+
# Problem: How to represent the following in Bash?
11+
1312
# {
1413
# "zulu": {
1514
# "yankee": {
@@ -21,6 +20,9 @@ In the coming days, I will release never seen before parsers written in Bash cal
2120
# }
2221
# }
2322

23+
24+
# Solution: Use bash-object to construct the hierarchy
25+
2426
declare -A root_object=()
2527
declare -A zulu_object=()
2628
declare -A yankee_object=()
@@ -47,15 +49,7 @@ assert [ "$REPLY" = rho ]
4749

4850
## Installation
4951

50-
STATUS: BETA
51-
5252
```sh
53-
echo "dependencies = [ 'hyperupcall/bash-object' ]" > 'bpm.toml'
54-
bpm install
53+
printf '%s\n' "dependencies = [ 'hyperupcall/bash-object' ]" > 'basalt.toml'
54+
basalt install
5555
```
56-
57-
## TODO
58-
- error if set in array out of bounds?
59-
- clean up argument parsing?
60-
- do something with 'is_index_of_array?' (do not allow for using index notation to get keys of objects)
61-
- set element of the same type that already exists (--overwrite?)

0 commit comments

Comments
 (0)