Commit 53682918 authored by Jose Narvaez's avatar Jose Narvaez
Browse files

Added LICENSE and README.

parent a22b3d5e
The MIT License (MIT)
Copyright (c) 2017 Jose Narvaez
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# users
API for accessing users and groups functionality in Redox.
High level APIs for things like:
- Getting the current process effective user ID.
- Getting the current process user ID.
- Getting the current process effective group ID.
- Getting the current process group ID.
- Getting the user information for a given user ID.
- Getting the group information for a given group ID.
- Getting the user information for a given username.
- Getting a group information for a given group name.
We recommend to user these APIs instead of directly manipulating
`/etc/group` and `etc/passwd` as this is an implementation detail and
might change in the future.
## Using users
Make sure you have Rust nightly.
Add `rust_users` to `Cargo.toml`:
```toml
[dependencies.ralloc]
git = "https://github.com/redox-os/users.git"
```
then import it in your main file:
```rust
extern crate rust_users;
```
`rust_users` is now ready to roll!
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment