diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e544bc --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Sudo Parental Control + +## Overview +Sudo Parental Control is a project aimed at implementing a system where children can use the `sudo` command, which then sends the request to a server for parental approval. This system allows parents to monitor and control the commands executed by their children on a shared server environment. + +## Features +- Child users can use the `sudo` command with restrictions. +- Requests made by children are sent to a server for parental approval. +- Parents can monitor and approve/reject commands executed by their children. +- Detailed logs and activity tracking for better monitoring. + +## Installation +1. Clone the repository: `git clone https://github.com/your-username/sudo-parental-control.git` +2. Install dependencies: `npm install` +3. Configure the server and client settings. +4. Run the application: `npm start` + +## Usage +1. Child users can use the `sudo` command followed by the desired command. +2. The request is sent to the server for parental approval. +3. Parents can approve or reject the command through the provided interface. +4. Logs and activity can be viewed for monitoring purposes. + +## Contributing +We welcome contributions to improve and enhance the Sudo Parental Control project. Feel free to fork the repository and submit pull requests with your changes. + +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Contact +For any questions or feedback, please contact us at [email@example.com](mailto:email@example.com). + +Thank you for considering Sudo Parental Control for your parental monitoring needs. We hope this project helps in creating a safer and controlled environment for your children's online activities.