Skip to content

Commit 1012c4f

Browse files
committed
Updated the README to add more generators to the Roadmap and to fix some of the content info.
Signed-off-by: Exadra37 <exadra37@gmail.com>
1 parent 3f0e4fc commit 1012c4f

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

README.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,6 @@ lib
5656
│ │ │ ├── create
5757
│ │ │ ├── delete
5858
│ │ │ ├── edit
59-
│ │ │ ├── export
60-
│ │ │ ├── import
6159
│ │ │ ├── list
6260
│ │ │ ├── new
6361
│ │ │ ├── read
@@ -85,8 +83,6 @@ lib
8583
│ │ ├── create
8684
│ │ ├── delete
8785
│ │ ├── edit
88-
│ │ ├── export
89-
│ │ ├── import
9086
│ │ ├── list
9187
│ │ ├── new
9288
│ │ ├── read
@@ -158,7 +154,7 @@ by adding `elixir_scribe` to your list of dependencies in `mix.exs`:
158154
```elixir
159155
def deps do
160156
[
161-
{:elixir_scribe, ">= 0.1.0", only: :dev}
157+
{:elixir_scribe, ">= 0.1.0", only: :dev, runtime: false}
162158
]
163159
end
164160
```
@@ -177,7 +173,7 @@ mix phx.new my_app --database sqlite3
177173
Now let's use the Elixir Scribe generators to create the domain `Catalog` and add to it the resource `Category` with the default actions:
178174

179175
```
180-
mix scribe.gen.html Catalog Category categories name:string desc:string --web Catalog
176+
mix scribe.gen.html Catalog Category categories name:string desc:string
181177
```
182178

183179
> Elixir Scribe default actions: create, delete, edit, list, new, read, update
@@ -186,13 +182,13 @@ mix scribe.gen.html Catalog Category categories name:string desc:string --web Ca
186182
Let's add to the domain `Catalog` the resource `Product` with custom actions on top of the default actions:
187183

188184
```
189-
mix scribe.gen.html Catalog Product products name:string desc:string --web Catalog --actions batch_create,batch_update
185+
mix scribe.gen.html Catalog Product products name:string desc:string --actions import,export
190186
```
191187

192-
Let's add the domain `Warehouse` with the resource `Iventory` without default actions. We will need to provide custom actions:
188+
Let's add the domain `Warehouse` with the resource `Stock` without default actions. We will need to provide custom actions:
193189

194190
```
195-
mix scribe.gen.html Warehouse Inventory inventories name:string desc:string --web Warehouse --actions batch_create,batch_update --no-default-actions
191+
mix scribe.gen.html Warehouse Stock stocks product_id:integer quantity:integer --actions import,export --no-default-actions
196192
```
197193

198194
[TOC](#toc)
@@ -216,6 +212,8 @@ The Elixir Scribe tool is highly opinionated, therefore I ask you to first [open
216212

217213
## Roadmap
218214

215+
The roadmap is extensive and due to the continuous high efforts and commitments to develop and maintain everything I may only provide some of the generators to Sponsors and/or as Pro versions that will require a paid license.
216+
219217
### Elixir Scribe Generators
220218

221219
- [ ] Mix task: `scribe.gen.domain`
@@ -224,6 +222,9 @@ The Elixir Scribe tool is highly opinionated, therefore I ask you to first [open
224222
- [ ] Mix task: `scribe.gen.home`
225223
* Removes current default Home page.
226224
* Adds new Home page with links to each Domain and Resource.
225+
* Optimizes default HTMl layout and components for a more clean and usable UI:
226+
+ Table headers in Bold
227+
+ Highlight links in blue, not in bold (black).
227228
- [ ] Mix task: `scribe.gen.ci`
228229
* Generates a CI file for Github or Gitlab with at least the following:
229230
+ `mix format --dry-run --check-formatted`
@@ -234,21 +235,34 @@ The Elixir Scribe tool is highly opinionated, therefore I ask you to first [open
234235
+ `mix credo`
235236
+ `mix doctor`
236237
+ `mix test --cover`
237-
- [ ] Mix task: `scribe.gen.project` -> Generates all Domains, Resources and Actions from an Elixir Scribe spec module `%ElixirScribe.ProjectSpecs{}`.
238+
- [ ] Mix task: `scribe.gen.project`
239+
* Generates all Domains, Resources and Actions from an Elixir Scribe spec module `%ElixirScribe.ProjectSpecs{}`.
238240
- [ ] Mix task: `scribe.gen.api`
241+
* Adds a dynamic API key (only valid for one request).
242+
* Adds support for fingerprinting the mobile and web app.
243+
* Adds support to collect metrics.
244+
* Adds a Secure Remote Configuration for mobile apps to avoid a new release:
245+
+ To rotate certificate pins. This enables dynamic certificate pinning on the mobile app.
246+
+ To change any settings pre-configured within the release binary (API endpoints, Menus, etc.).
247+
+ To control feature flags.
248+
+ To enable a kill-switch to force upgrade to a new version.
249+
+ To dynamically conduct experiments with user experience, A/B testing.
250+
- [ ] Mix task: `scribe.gen.auth`
251+
* Adds enhanced User Authentication:
252+
+ fingerprinting of the client enabled by default
253+
+ enabled by default to all pages, except Home page.
254+
- [ ] Mix task: `scribe.gen.oauth`
255+
* Adds enhanced OAuth for popular providers:
256+
+ fingerprinting of the client enabled by default
257+
+ enabled by default to all pages, except Home page.
239258
- [ ] Mix task: `scribe.gen.native`
240259
* Enables the project to be built for Desktop, Android and Apple.
241260
* Elixir libraries to build for native targets:
242261
+ [LiveView Native](https://github.com/liveview-native)
243262
+ [Elixir Desktop](https://github.com/elixir-desktop/desktop)
244263
+ [ExTauri](https://github.com/Exadra37/ex_tauri)
264+
- [ ] Mix task: `scribe.gen.static`
265+
* Generates a static website from a current project.
266+
- [ ] Mix task: `scribe.gen.deploy`
267+
* Adds easy deployment to popular hosting providers.
245268
- [ ] Mix task: `scribe.gen.admin`
246-
247-
### Improvements
248-
249-
- [ ] Optimize default HTMl layout and components for a more clean and usable UI.
250-
- [ ] Table headers in Bold
251-
- [ ] Highlight links in blue, not in bold (black).
252-
- [ ] Add Authentication by default to all pages, except Home page.
253-
- [ ] Add dynamic API key (only valid for one request)
254-
- [ ] Add Remote Configuration for mobile apps

0 commit comments

Comments
 (0)