Skip to content

Commit f2f9bc9

Browse files
committed
docs: cleanup README
1 parent 48b862d commit f2f9bc9

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
`numero` is software for parsing and evaluating mathematical expressions. It is available as a library and as a web service.
99

10-
### motivation
10+
## motivation
1111

1212
This project started as an exercise in doing some recreational programming. I always knew about the [shunting yard algorithm](https://en.wikipedia.org/wiki/Shunting_yard_algorithm) but never really got to implement it. Lately, I've been writing a lot of code in Go and decided to just do this.
1313

14-
### usage
14+
## usage
1515

1616
The library can be used as follows.
1717

@@ -56,7 +56,7 @@ curl --request POST \
5656
}'
5757
```
5858

59-
### documentation
59+
## documentation
6060

6161
**Supported functions**
6262
- `sin`
@@ -68,6 +68,13 @@ curl --request POST \
6868
- `max`
6969
- `min`
7070

71+
**Supported operators**
72+
- `+`
73+
- `-`
74+
- `*`
75+
- `/`
76+
- `^`
77+
7178
**API**
7279

7380
`POST /api/v1/eval`
@@ -88,7 +95,7 @@ Response body:
8895
}
8996
```
9097

91-
### contributing
98+
## contributing
9299

93100
I am happy to accept pull requests. No hard rules.
94101

@@ -106,6 +113,6 @@ make test
106113
make run-dev
107114
```
108115

109-
### acknowledgements
116+
## acknowledgements
110117

111118
created by Vivek Nathani ([@viveknathani_](https://twitter.com/viveknathani_)), licensed under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)