Skip to content

Commit f7958d9

Browse files
committed
Update README
1 parent ddd0ec7 commit f7958d9

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Phada
22
=====
33

4+
[![Go Reference](https://pkg.go.dev/badge/github.com/nndi-oss/phada.svg)](https://pkg.go.dev/github.com/nndi-oss/phada)
5+
46
Phada is a small utility for _dealing with_ AfricasTalking's USSD input. If you've tried to build a USSD application with AT you may have come about the "asterix input problem" i.e. where the data is fed to your application as asterisk separated (ASV?) data.
57

68
Phada is a library to reduce the ceremony required to read user's current input, as a bonus you get a way to store the session data
@@ -9,6 +11,12 @@ Phada is [Chichewa](https://en.wikipedia.org/wiki/Chichewa) for `Hopscotch`.
911

1012
## USAGE
1113

14+
Install the module
15+
16+
```sh
17+
$ go get github.com/nndi-oss/[email protected]
18+
```
19+
1220
If you're using the standard `net/http` package then you can create the UssdRequestSession
1321
using the `ParseUssdRequest(*http.Request)` function. Otherwise you will have to
1422
fill the `UssdRequestSession` struct yourself if you're using a framework like Gin, Echo, etc..

0 commit comments

Comments
 (0)