Skip to content

Commit 76d21cd

Browse files
authored
Merge pull request #10 from RobLoach/docs
Add documentation
2 parents 30021a2 + 85279d5 commit 76d21cd

File tree

1 file changed

+66
-3
lines changed

1 file changed

+66
-3
lines changed

README.md

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,69 @@ User contributed wrappers for ChaiScript.
44

55
## Modules
66

7-
- Math: Adds common math methods to ChaiScript.
8-
- String ID: String hashing with [string_id](https://github.com/foonathan/string_id)
9-
- String Methods: Introduces some extra string methods to ChaiScript strings
7+
- [Math](#math): Adds common math methods to ChaiScript.
8+
- [String ID](#string-id): String hashing with [string_id](https://github.com/foonathan/string_id)
9+
- [String Methods](#string-methods): Introduces some extra string methods to ChaiScript strings
10+
11+
### Math
12+
13+
The Math module adds some standard math functions to ChaiScript.
14+
15+
#### Install
16+
``` cpp
17+
#include "chaiscript/extras/math.hpp"
18+
```
19+
``` cpp
20+
chaiscript::ChaiScript chai;
21+
auto mathlib = chaiscript::extras::math::bootstrap();
22+
chai.add(mathlib);
23+
```
24+
25+
#### Usage
26+
27+
``` chaiscript
28+
var result = cos(0.5f)
29+
```
30+
31+
### String ID
32+
33+
Adds [String ID](https://github.com/foonathan/string_id) support to ChaiScript.
34+
35+
#### Install
36+
37+
``` cpp
38+
#include "chaiscript/extras/string_id.hpp"
39+
```
40+
41+
``` cpp
42+
auto string_idlib = chaiscript::extras::string_id::bootstrap();
43+
chai.add(string_idlib);
44+
```
45+
46+
### String Methods
47+
48+
Adds various string methods to extend how strings can be used in ChaiScript:
49+
- `string::replace(string, string)`
50+
- `string::trim()`
51+
- `string::split(string)`
52+
- `string::toLowerCase()`
53+
- `string::toUpperCase()`
54+
55+
#### Install
56+
57+
``` cpp
58+
#include "chaiscript/extras/string_methods.hpp"
59+
```
60+
61+
``` cpp
62+
auto stringmethods = chaiscript::extras::string_methods::bootstrap();
63+
chai.add(stringmethods);
64+
```
65+
66+
#### Usage
67+
68+
``` chaiscript
69+
var input = "Hello, World!"
70+
var output = input.replace("Hello", "Goodbye")
71+
// => "Goodbye, World!"
72+
```

0 commit comments

Comments
 (0)