diff --git a/README.md b/README.md index 12787ad..d319df3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ -SYSACTIONS -========== +# sysactions + +Shell functions to gather informations on a system... (probably as a base +for a deployment tool). + +## Synopsis + + run.sh + +## Description This is a bunch of shell func that gather as much information as possible about a system and adds the ability to perfom actions @@ -12,3 +20,34 @@ are already familiar with shell scripting so this might be ideal. Well, I end up with a really not to bad amount of informations I could gather pretty easy. + +## Requirements + +Tested with bash ... probably not working with other shells. + +## Dependencies + +Probably some... + +## Contributing + +Just email me. + +## License + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +## Author + +Georg Hopp