Skip to content

chore: update readme to remove no compilable examples and update instalation instruction #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thiagodejesus merged 1 commit into from
May 22, 2025
Merged

chore: update readme to remove no compilable examples and update instalation instruction #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 2 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,36 +16,12 @@ Add this to your `Cargo.toml`:

```toml
[dependencies]
grid_engine = "0.1.0"
grid_engine = {version = "*"}
```

## Usage

Here's a basic example of using grid_engine:

```rust
use grid_engine::grid_engine::GridEngine;

// Create a new 10x12 grid
let mut grid = GridEngine::new(10, 12);

// Add a change listener to track modifications
grid.events.add_changes_listener(Box::new(|event| {
println!("Grid changed: {:?}", event.changes);
}));

// Add items to the grid (with automatic collision handling)
grid.add_item("box1".to_string(), 0, 0, 2, 2).unwrap();
grid.add_item("box2".to_string(), 0, 0, 2, 2).unwrap(); // Will be repositioned to avoid collision

// Move items
grid.move_item("box1", 2, 2).unwrap();

// Remove items
grid.remove_item("box2").unwrap();
```

Check out the [examples](examples/) directory for more usage examples.
Check out the [examples](examples/) directory for usage examples.

## API Overview

Expand Down