Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Got rid of release info - added short usage example of writing INI files.
  • Loading branch information
wallyhall committed Apr 12, 2016
1 parent d670165 commit 40dd484
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@ shini [![Build Status](https://travis-ci.org/wallyhall/shini.svg?branch=master)]

A small, minimialist, portable `/bin/sh` routine for reading (and now very alpha-quality writing) of INI files.

## IMPORTANT NOTE ABOUT RELEASES
Release 0.9 is mostly stable; the only major known bug is the last line of INI files is skipped from parsing if there's no empty new line at the end of the file. (Easy work-around...)

The latest code has alpha support for writing - you can perform writes like so:

```
shini_write "filename.ini" "SECTION" "key" "New Value"
```

## About

### What is `shini`?
Expand Down Expand Up @@ -141,6 +132,16 @@ shini_parse "settings.ini"

Bingo. A full (and simple example) can be found in `example.sh`.

### ...and what about writing data too?

Easy!

```
shini_write "filename.ini" "SECTION_NAME" "key_name" "Some value here!"
```

This will update existing values and append new ones. As always - give really careful thought to your INI file filesystem permissions before allowing users to arbitarily change the content!

### Can I override the error handling?

Yes. Just declare any or all of the following functions:
Expand Down

0 comments on commit 40dd484

Please sign in to comment.