Skip to content

Commit 0f75590

Browse files
readme edit
1 parent 90aa096 commit 0f75590

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,31 @@ 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. PostgreSQL
46+
3. Redis
47+
4. MongoDB
48+
5. Memory
49+
6. ~~UnQLite~~ `deprecated` / retiring soon
4950

5051
## Examples
52+
Try Mapless by [installing it in a supported Pharo image](#install) and the following snippets:
5153

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

8499
```Smalltalk
85-
"Create a Person mapless model"
100+
"Create a Person Mapless model"
86101
philosopher := Person new
87102
firstName: 'Aristotle';
88103
save.
89104
90-
"Set it as the person for a new User mapless model"
105+
"Set it as the person for a new User Mapless model"
91106
philosopherUser := User new
92107
person: philosopher;
93108
save.
@@ -97,7 +112,7 @@ aristotle := (User findId: philosopherUser id) person.
97112
```
98113
## Install
99114

100-
Open a workspace in a supported Pharo image and evaluate:
115+
To start with Mapless, download Pharo, open a Pharo Playground and evaluate:
101116

102117
```smalltalk
103118
Metacello new
@@ -108,7 +123,7 @@ Metacello new
108123

109124
## Include as dependency
110125

111-
In BaselineOf or ConfigurationOf it can be added in this way:
126+
To include Mapless as a dependency from BaselineOf or ConfigurationOf add it with:
112127

113128
```smalltalk
114129
spec
@@ -117,6 +132,6 @@ spec
117132
repository: 'github://sebastianconcept/Mapless:latest/src';
118133
load: #('Core' 'Postgres' 'Mongo' 'Redis' 'Memory') ]
119134
```
120-
## Ambition
135+
## Project Ambition
121136

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.
137+
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)