Skip to content

Commit

Permalink
readme edit
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianconcept committed Jan 30, 2024
1 parent 8dfa0f8 commit 8523bcf
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Schema-less persistence for Smalltalk with support for multiple backends.

## Description

Mapless is a schema-less persistence framework supporting multiple backends and offering a user-friendly API. For instance, querying Mapless objects involves a common family of methods, and there's no need to declare accessors and mutators. See [examples below](#examples).
Mapless is a schema-less persistence framework supporting multiple backends and offering a user-friendly API. Querying Mapless objects involves a common family of methods, and there's no need to declare accessors and mutators. See [examples below](#examples).

Designed to be schema-less, Mapless eliminates the need for schema maintenance and avoids any Object-Relational Mapping requirements.
Designed to eliminate the need for schema maintenance, Mapless avoids any Object-Relational Mapping requirements.

Mapless achieves a balance of maximum data survivability and robust architectural flexibility without imposing a heavy burden in terms of adoption and maintenance.
Mapless achieves a balance between maximum data survivability and robust architectural flexibility without imposing a heavy burden in terms of adoption and maintenance. A sweet spot for development and production.

## Features

Expand Down Expand Up @@ -66,6 +66,9 @@ Mapless subclass: #Person
classVariableNames: ''
package: 'YourApp-Mapless'
"Guarantees the database has a Person table (this is idempotent)."
repository ensureTableFor: #Person.
"Instantiates a Mapless object."
philosopher := Person new
firstName: 'Aristotle';
Expand Down Expand Up @@ -111,27 +114,29 @@ philosopherUser := User new
"Query for that user by ID and get its person instance"
aristotle := (User findId: philosopherUser id) person.
```
## Install
## How to Install

To start with Mapless, download Pharo, open a Pharo Playground and evaluate:

```smalltalk
Metacello new
baseline: 'Mapless';
repository: 'github://sebastianconcept/Mapless:latest/src';
load
load.
"By default, Mapless loads the Memory and SQLite backends"
```

## Include as dependency

To include Mapless as a dependency from BaselineOf or ConfigurationOf add it with:
To include Mapless as a dependency from `BaselineOf` or `ConfigurationOf` add it with:

```smalltalk
spec
baseline: 'Mapless'
with: [ spec
repository: 'github://sebastianconcept/Mapless:latest/src';
load: #('Core' 'Postgres' 'Mongo' 'Redis' 'Memory') ]
load: #('Core' 'SQLite' 'Postgres' 'Mongo' 'Redis' 'Memory') ]
```
## Project Ambition

Expand Down

0 comments on commit 8523bcf

Please sign in to comment.