diff --git a/README.md b/README.md index c2e6c51..511c9ec 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# Mailbox - A POSIX Shared Memory Multi-Directional Message Queue +# Mailbox - A POSIX Shared Memory Multi-Directional Message Queue Library [![Unit Tests](https://github.com/matthambrecht/Mailbox/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/matthambrecht/Mailbox/actions/workflows/run-tests.yaml) -This is a C library to facilitate IPC (interprocess communication) allowing -multi-directional message sharing. It is designed to mimic the organization of postal systems. Made to be thread-safe using POSIX `semaphore.h`. + +This is a C library to facilitate IPC (interprocess communication) by allowing +multi-directional message sharing. It is designed to mimic the organization of postal systems and made to be thread-safe using POSIX `semaphore.h`. ## What is IPC (interprocess communication) "In computer science, interprocess communication (IPC) is the sharing of data between running processes in a computer system. Mechanisms for IPC may be provided by an operating system. Applications which use IPC are often categorized as clients and servers, where the client requests data and the server responds to client requests. Many applications are both clients and servers, as commonly seen in distributed computing." - [Wikipedia/Inter-process Communication](https://en.wikipedia.org/wiki/Inter-process_communication) diff --git a/mailbox.h b/mailbox.h index 10b5309..82dfc31 100644 --- a/mailbox.h +++ b/mailbox.h @@ -1,5 +1,9 @@ /* mailbox.h - A Unix Shared Memory Mailing System for IPC + +Author: Matthew Hambrecht (https://github.com/matthambrecht) +Version: v1.2.0 +Documentation: https://github.com/matthambrecht/Mailbox/blob/main/README.md */ #ifndef MAILBOX_H