Extended readme

Author: mhahnFr

README.md

@@ -1,9 +1,28 @@
 # Welcome to the CallstackLibrary!
-This is a library creating humanreadable callstacks by parsing the debug symbols of
-the executable, if they are available. Otherwise, the dynamic linker information is used.
+This repository contains a library which can create human readable callstacks. It features a C API, but
+there is also a C++ wrapper for it.
 
 ## Usage
-_Coming soon!_
+In order to get started, you can either download a compiled version of the library [here](https://www.github.com/mhahnFr/CallstackLibrary/releases).  
+Alternatively, you can also build it from source:
+- Clone the repository: ``git clone https://www.github.com/mhahnFr/CallstackLibrary``
+- and build the library: ``cd CallstackLibrary && make``.
+
+On some systems, you might need to install the ``libexecinfo-dev`` to compile the library successfully.
+If this is the case, add ``-lexecinfo`` to the linking flags.
+
+In order to use this library, simply include the header [``callstack.h``](https://www.github.com/mhahnFr/CallstackLibrary/blob/main/include/callstack.h).
+
+**Linking**:
+- On **macOS**, link using these flags: ``-L<path/to/library> -lcallstack``.
+- On **Linux**, link with ``-rdynamic -L<path/to/library> -lcallstack -ldl``.
+- On **FreeBSD**, link with ``-rdynamic -L<path/to/library> -lcallstack -ldl -lexecinfo``.
+
+The complete set of features is described in the [wiki](https://www.github.com/mhahnFr/CallstackLibrary/wiki).
+
+## Upcoming features
+The callstacks are currently created using the informations of  the dynamic linker.
+In the future, parsing of the debug symbols will be added.
 
 ### Final notes
 This library is licensed under the terms of the GPL 3.0.