Skip to content

Commit

Permalink
renamed project to froggr
Browse files Browse the repository at this point in the history
  • Loading branch information
doriancodes committed Dec 11, 2024
1 parent f9cc02c commit bbbab06
Show file tree
Hide file tree
Showing 18 changed files with 54 additions and 44 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "frogger"
name = "froggr"
description = "🐸 Simple file system implementation using the 9P protocol"
version = "0.1.2"
authors = ["Dorian Davì <frogger[email protected]>"]
version = "0.1.0"
authors = ["Dorian Davì <froggr[email protected]>"]
license = "BSD-3-Clause"
repository = "https://github.com/doriancodes/frogger"
documentation = "https://docs.rs/frogger"
repository = "https://github.com/doriancodes/froggr"
documentation = "https://docs.rs/froggr"
readme = "README.md"
keywords = ["filesystem", "9p", "fuse", "bind", "namespace"]
categories = ["filesystem", "os::unix-apis", "virtualization"]
Expand Down
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Frogger 🐸
# froggr 🐸

Simple file system implementation using the 9P protocol

Expand Down Expand Up @@ -66,11 +66,21 @@ For isolating environments, such as creating chroot-like environments or managin

## User Guide

The user guide is available online at [doriancodes.github.io/frogger](https://doriancodes.github.io/frogger/) and can be built locally using [mdBook](https://rust-lang.github.io/mdBook/). To build and serve the documentation locally:
The user guide is available online at [doriancodes.github.io/froggr](https://doriancodes.github.io/froggr/) and can be built locally using [mdBook](https://rust-lang.github.io/mdBook/). To build and serve the documentation locally:

```bash
mdbook serve docs/
```

This will serve the documentation at [localhost:3000](http://localhost:3000).

### Commands:
- `bind`: Bind a source directory to a target directory
- `mount`: Mount a directory to a mount point

For more details, use `frg --help`

## License

BSD-3-Clause

4 changes: 2 additions & 2 deletions docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ authors = ["doriancodes"]
language = "en"
multilingual = false
src = "src"
title = "Frogger User Guide"
title = "froggr User Guide"
description = "🐸 Simple file system implementation using the 9P protocol"

[output.html]
git-repository-url = "https://github.com/doriancodes/frogger"
git-repository-url = "https://github.com/doriancodes/froggr"
git-repository-icon = "fa-github"
4 changes: 2 additions & 2 deletions docs/src/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Frogger 🐸
# froggr 🐸

Simple file system implementation using the 9P protocol

Frogger is a modern implementation of the Plan 9 filesystem protocol (9P), focusing on providing flexible namespace management through bind operations.
froggr is a modern implementation of the Plan 9 filesystem protocol (9P), focusing on providing flexible namespace management through bind operations.

## What is 9P?

Expand Down
2 changes: 1 addition & 1 deletion docs/src/reference/cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CLI Reference

Complete reference for the Frogger command-line interface.
Complete reference for the froggr command-line interface.

## Global Options

Expand Down
8 changes: 4 additions & 4 deletions docs/src/reference/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

1. Clone the repository:
```shell
git clone https://github.com/yourusername/frogger.git
cd frogger
git clone https://github.com/yourusername/froggr.git
cd froggr
```

2. Build and install:
Expand All @@ -26,12 +26,12 @@ This will install the `frg` binary to your cargo bin directory (usually `~/.carg
Install directly from crates.io:

```shell
cargo install frogger
cargo install froggr
```

## Verifying Installation

After installation, verify that Frogger is working correctly:
After installation, verify that froggr is working correctly:

```shell
frg --version
Expand Down
2 changes: 1 addition & 1 deletion docs/src/user-guide/bind-modes/after.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ frg bind -a src mountpoint

## Behavior

Frogger resolves lookups by searching the original `mountpoint` first, and if the file isn't found there, it checks the `src`. This maintains existing content's priority while providing additional fallback options.
froggr resolves lookups by searching the original `mountpoint` first, and if the file isn't found there, it checks the `src`. This maintains existing content's priority while providing additional fallback options.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/src/user-guide/bind-modes/before.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ frg bind -b src mountpoint

## Behavior

When a lookup occurs, Frogger searches `src` first, and if the file isn't found there, it searches the original `mountpoint`. This creates a layered view where new content takes precedence over existing content.
When a lookup occurs, froggr searches `src` first, and if the file isn't found there, it searches the original `mountpoint`. This creates a layered view where new content takes precedence over existing content.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/src/user-guide/bind-modes/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ frg bind -c src mountpoint

## Behavior

Before performing the bind operation, Frogger checks if the mountpoint exists. If it doesn't, the directory is created automatically. After creation (if needed), it performs a standard replace binding.
Before performing the bind operation, froggr checks if the mountpoint exists. If it doesn't, the directory is created automatically. After creation (if needed), it performs a standard replace binding.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/src/user-guide/bind-modes/replace.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Replace Mode

The Replace mode is the default binding mode in Frogger. It completely replaces whatever was previously mounted at the mountpoint with the new source.
The Replace mode is the default binding mode in froggr. It completely replaces whatever was previously mounted at the mountpoint with the new source.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/src/user-guide/bind.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The P9 protocol for file systems requires a unique feature called `bind`, which

## Available Modes

Frogger supports four binding modes:
froggr supports four binding modes:
- [Replace Mode](bind-modes/replace.md): Replace existing content
- [Before Mode](bind-modes/before.md): Add content with higher priority
- [After Mode](bind-modes/after.md): Add content with lower priority
Expand Down
6 changes: 3 additions & 3 deletions examples/bind_after.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
mod common;

use anyhow::Result;
use frogger::modules::namespace::BindMode;
use frogger::FilesystemManager;
use frogger::NineP;
use froggr::modules::namespace::BindMode;
use froggr::FilesystemManager;
use froggr::NineP;
use std::path::{Path, PathBuf};

#[tokio::main]
Expand Down
6 changes: 3 additions & 3 deletions examples/bind_before.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
mod common;

use anyhow::Result;
use frogger::modules::namespace::BindMode;
use frogger::FilesystemManager;
use frogger::NineP;
use froggr::modules::namespace::BindMode;
use froggr::FilesystemManager;
use froggr::NineP;
use std::path::{Path, PathBuf};

#[tokio::main]
Expand Down
6 changes: 3 additions & 3 deletions examples/bind_create.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
mod common;

use anyhow::Result;
use frogger::modules::namespace::BindMode;
use frogger::FilesystemManager;
use frogger::NineP;
use froggr::modules::namespace::BindMode;
use froggr::FilesystemManager;
use froggr::NineP;
use std::path::{Path, PathBuf};

#[tokio::main]
Expand Down
6 changes: 3 additions & 3 deletions examples/bind_replace.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
mod common;

use anyhow::Result;
use frogger::modules::namespace::BindMode;
use frogger::FilesystemManager;
use frogger::NineP;
use froggr::modules::namespace::BindMode;
use froggr::FilesystemManager;
use froggr::NineP;
use std::path::{Path, PathBuf};

#[tokio::main]
Expand Down
14 changes: 7 additions & 7 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#![doc(html_root_url = "https://docs.rs/frogger/0.1.1")]
#![doc(html_root_url = "https://docs.rs/froggr/0.1.1")]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(missing_docs)]
#![deny(rustdoc::missing_crate_level_docs)]

//! # Frogger 🐸
//! froggr: A simple file system implementation using the 9P protocol
//!
//! A simple file system implementation using the 9P protocol.
//!
Expand All @@ -17,7 +17,7 @@
//! ## Quick Start
//!
//! ```rust,no_run
//! use frogger::{FilesystemManager, NineP, BindMode};
//! use froggr::{FilesystemManager, NineP, BindMode};
//! use std::path::PathBuf;
//!
//! # fn main() -> anyhow::Result<()> {
Expand All @@ -42,10 +42,10 @@
//! - `After`: Adds content with lower priority
//! - `Create`: Creates mountpoint if needed
/// Core filesystem modules and implementations.
pub mod modules;

// Re-export key types for easy access
pub use modules::mount::FilesystemManager;
pub use modules::namespace::{BindMode, NamespaceManager};
pub use modules::proto::{BoundEntry, NineP};
pub use modules::proto::NineP;

// Re-export commonly used types
pub use modules::namespace::BindMode;
6 changes: 3 additions & 3 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
use anyhow::Result;
use clap::{Parser, Subcommand};
use env_logger;
use frogger::modules::namespace::BindMode;
use frogger::FilesystemManager;
use frogger::NineP;
use froggr::modules::namespace::BindMode;
use froggr::FilesystemManager;
use froggr::NineP;
use log::info;
use std::path::PathBuf;

Expand Down

0 comments on commit bbbab06

Please sign in to comment.