From 3db4a8fcaa6454cec443fdfd6c5fcd3f6bc82ecd Mon Sep 17 00:00:00 2001 From: Tyler Perkins Date: Fri, 29 Apr 2022 15:20:19 -0400 Subject: [PATCH] Update README and Makefile --- Makefile | 4 ++-- README.md | 18 ++++++++++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 81d41e5..c39bc15 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ FLAGS = -pipe CFLAGS = -Wall CFLAGS += -Ofast -#CFLAGS += -flto +CFLAGS += -flto #CFLAGS += -g #CFLAGS += -pg @@ -23,7 +23,7 @@ BIN = ./bin PREFIX = /usr/local MANPREFIX = $(PREFIX)/share/man -TARGET = crowtest +TARGET = proc-api MAKEFLAGS += --jobs=4 diff --git a/README.md b/README.md index f8cb75e..03cfe19 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ -Learn crow +Proc-API ========== -Learning the crow web framework +This is a lightweight, fast, RESTful API designed around the /proc filesystem +in linux. It allows for stateless monitoring of remote linux systems with +automated tools. + +What is this good for? +---------------------- + +* Remote monitoring +* Collecting stats on a remote system +* Client applications for VPS hosters + +What is the API? +---------------- + +See [DOCUMENTATION.md](DOCUMENTATION.md)