Skip to content

Added table of contents to readme #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DougBeney wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added table of contents to readme #102

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56a8bba
TOC
Nov 10, 2018
7a0e830
toc cleanup
Nov 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,35 @@ is a faster version of `sdscatprintf` that can be used for the simpler
cases in order to avoid the libc `printf` family functions performance
penalty.

**Table of Contents**

- [Simple Dynamic Strings](#simple-dynamic-strings)
- [How SDS strings work](#how-sds-strings-work)
- [Advantages and disadvantages of SDS](#advantages-and-disadvantages-of-sds)
- [SDS basics](#sds-basics)
- [Creating SDS strings](#creating-sds-strings)
- [Obtaining the string length](#obtaining-the-string-length)
- [Destroying strings](#destroying-strings)
- [Concatenating strings](#concatenating-strings)
- [Formatting strings](#formatting-strings)
- [Fast number to string operations](#fast-number-to-string-operations)
- [Trimming strings and getting ranges](#trimming-strings-and-getting-ranges)
- [String copying](#string-copying)
- [Quoting strings](#quoting-strings)
- [Tokenization](#tokenization)
- [Command line oriented tokenization](#command-line-oriented-tokenization)
- [String joining](#string-joining)
- [Error handling](#error-handling)
- [SDS internals and advanced usage](#sds-internals-and-advanced-usage)
- [Shrinking strings](#shrinking-strings)
- [Manual modifications of SDS strings](#manual-modifications-of-sds-strings)
- [Sharing SDS strings](#sharing-sds-strings)
- [Interactions with heap checkers](#interactions-with-heap-checkers)
- [Zero copy append from syscalls](#zero-copy-append-from-syscalls)
- [Embedding SDS into your project](#embedding-sds-into-your-project)
- [Using a different allocator for SDS](#using-a-different-allocator-for-sds)
- [Credits and license](#credits-and-license)

How SDS strings work
===

Expand Down