Skip to content

Commit e19d4b6

Browse files
readme edit
1 parent 90aa096 commit e19d4b6

File tree

1 file changed

+24
-10
lines changed

1 file changed

+24
-10
lines changed

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,30 @@ Mapless achieves a balance of maximum data survivability and robust architectura
4141

4242
## Supported backends
4343

44-
1. MongoDB
45-
2. Redis
46-
3. Memory
47-
4. PostgreSQL
48-
5. ~~UnQLite~~ `deprecated` / retiring soon
44+
1. SQLite
45+
2. MongoDB
46+
3. Redis
47+
4. Memory
48+
5. PostgreSQL
49+
6. ~~UnQLite~~ `deprecated` / retiring soon
4950

5051
## Examples
5152

5253
```Smalltalk
53-
"Instanciates a mapless object."
54+
"Instantiates an SQLite Mapless repository."
55+
repository := MaplessSQLiteRepository
56+
for: 'TryMapless'
57+
on: 'path/string/to/your/sqlite.db'.
58+
```
59+
60+
```Smalltalk
61+
"Custom class to model your data"
62+
Mapless subclass: #Person
63+
instanceVariableNames: ''
64+
classVariableNames: ''
65+
package: 'YourApp-Mapless'
66+
67+
"Instantiates a Mapless object."
5468
philosopher := Person new
5569
firstName: 'Aristotle';
5670
yourself.
@@ -82,12 +96,12 @@ oneOrNil := repository findOne: Person where: [ :each |
8296
```
8397

8498
```Smalltalk
85-
"Create a Person mapless model"
99+
"Create a Person Mapless model"
86100
philosopher := Person new
87101
firstName: 'Aristotle';
88102
save.
89103
90-
"Set it as the person for a new User mapless model"
104+
"Set it as the person for a new User Mapless model"
91105
philosopherUser := User new
92106
person: philosopher;
93107
save.
@@ -117,6 +131,6 @@ spec
117131
repository: 'github://sebastianconcept/Mapless:latest/src';
118132
load: #('Core' 'Postgres' 'Mongo' 'Redis' 'Memory') ]
119133
```
120-
## Ambition
134+
## Project Ambition
121135

122-
To deliver a high-performance solution that preserves arbitrary application state (data) with a focus on flexibility, availability, and capacity. It aims to strategically aid in scaling without causing backend vendor lock-in, across various persistence backends, and by neutralizing the costs associated with object-mapping impedance mismatch.
136+
To deliver a high-performance solution that preserves arbitrary application state (data) with a focus on flexibility, availability, and capacity. It aims to strategically aid in scaling without causing vendor lock-in, across various persistence backends, and by neutralizing the costs associated with object-mapping impedance mismatch.

0 commit comments

Comments
 (0)