Merge pull request #5994 from WiXSL/docs-readme

[Doc] Synchronize Readme files
marmelab · Mar 15, 2021 · 2c9bb4a · 2c9bb4a
2 parents 0ab417d + 6313218
commit 2c9bb4a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -68,7 +68,7 @@ The `<Resource>` component is a configuration component that allows to define su
 // in posts.js
 import * as React from "react";
 import { List, Datagrid, Edit, Create, SimpleForm, DateField, TextField, EditButton, TextInput, DateInput } from 'react-admin';
-import BookIcon from '@material-ui/core/svg-icons/action/book';
+import BookIcon from '@material-ui/icons/Book';
 export const PostIcon = BookIcon;
 
 export const PostList = (props) => (
@@ -93,7 +93,7 @@ export const PostEdit = (props) => (
         <SimpleForm>
             <TextInput disabled source="id" />
             <TextInput source="title" />
-            <TextInput source="teaser" options={{ multiLine: true }} />
+            <TextInput source="teaser" options={{ multiline: true }} />
             <TextInput multiline source="body" />
             <DateInput label="Publication date" source="published_at" />
             <TextInput source="average_note" />
@@ -106,7 +106,7 @@ export const PostCreate = (props) => (
     <Create title="Create a Post" {...props}>
         <SimpleForm>
             <TextInput source="title" />
-            <TextInput source="teaser" options={{ multiLine: true }} />
+            <TextInput source="teaser" options={{ multiline: true }} />
             <TextInput multiline source="body" />
             <TextInput label="Publication date" source="published_at" />
             <TextInput source="average_note" />

diff --git a/docs/Readme.md b/docs/Readme.md
@@ -15,6 +15,8 @@ using:
 
 ```sh
 npm install react-admin
+#or
+yarn add react-admin
 ```
 
 ## Usage

diff --git a/packages/react-admin/README.md b/packages/react-admin/README.md
@@ -77,7 +77,7 @@ The `<Resource>` component is a configuration component that allows to define su
 // in posts.js
 import * as React from "react";
 import { List, Datagrid, Edit, Create, SimpleForm, DateField, TextField, EditButton, TextInput, DateInput } from 'react-admin';
-export PostIcon from '@material-ui/core/svg-icons/action/book';
+export PostIcon from '@material-ui/icons/Book';
 
 export const PostList = (props) => (
     <List {...props}>
@@ -101,7 +101,7 @@ export const PostEdit = (props) => (
         <SimpleForm>
             <TextInput disabled source="id" />
             <TextInput source="title" />
-            <TextInput source="teaser" options={{ multiLine: true }} />
+            <TextInput source="teaser" options={{ multiline: true }} />
             <TextInput multiline source="body" />
             <DateInput label="Publication date" source="published_at" />
             <TextInput source="average_note" />
@@ -114,7 +114,7 @@ export const PostCreate = (props) => (
     <Create title="Create a Post" {...props}>
         <SimpleForm>
             <TextInput source="title" />
-            <TextInput source="teaser" options={{ multiLine: true }} />
+            <TextInput source="teaser" options={{ multiline: true }} />
             <TextInput multiline source="body" />
             <TextInput label="Publication date" source="published_at" />
             <TextInput source="average_note" />