diff --git a/README.md b/README.md index 8fbb809..46e9c92 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# server-performance-stats +# Server performance stats +> The script to analyse basic server performance stats. -The script to analyse basic server performance stats. \ No newline at end of file +## Getting started + +### Installing + +``` +git clone https://git.inotfail.com/ami-chuu/server-performance-stats +mv server-performance-stats/server-stats.sh ~/server-stats.sh +chmod +x ~/server-stats.sh +``` + +### Run on login + +``` +echo "bash $HOME/server-stats.sh" >> $HOME/.bashrc +``` + +## Links + +- Repository: https://git.inotfail.com/ami-chuu/server-performance-stats +- Issue tracker: https://git.inotfail.com/ami-chuu/server-performance-stats/issues + +## Licensing + +The code in this project is licensed under MIT license. \ No newline at end of file