Skip to content

Commit 7c964d1

Browse files
committed
fix some typos
1 parent 9ac2f48 commit 7c964d1

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README-Finder.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The new version of **django-filer** is not yet available on PyPI. Therefore, you
105105
from GitHub:
106106

107107
```shell
108-
git clone django-filer
108+
git clone https://github.com/django-cms/django-filer.git
109109
cd django-filer
110110
git switch finder
111111
pip install --no-deps -e .
@@ -114,10 +114,10 @@ pip install --no-deps -e .
114114
The new version of **django-filer** requires Django-5.2 or later. Since this currently is not
115115
released, you have to install the current development version of Django from GitHub as well.
116116

117-
The new version of **django-filer** currently has been tested with SQLite and Postgres, but should
118-
also work on MariaDB and MySQL.
117+
The new version of **django-filer** currently has only been tested with SQLite and Postgres, but
118+
should also work on MariaDB and MySQL.
119119

120-
In `settings.py` of your project, add these extra dependencies or those one you really need:
120+
In `settings.py` of your project, add these extra dependencies or those you really need:
121121

122122
```python
123123
INSTALLED_APPS = [
@@ -157,12 +157,12 @@ python manage.py filer_to_finder
157157
This does not affect the original database tables. You can still use the original **django-filer**
158158
codebase in parallel to the new "Finder" branch. They both share the same underlying file system,
159159
usually `media/filer_public` but store their meta information in completely independent database
160-
tables. The only cavat is that you should not erase files in the trash folder, because then they are
161-
also gone on disk.
160+
tables. The only caveat is that you should not erase files in the trash folder, because then they
161+
are also gone on disk.
162162

163163
The client part of the new admin user must be compiled before it can be used. This requires a modern
164164
version (18 or later) of [Node.js](https://nodejs.org/en/) and [npm](https://www.npmjs.com/), which usually are installed anyway.
165-
The following commands installs the requirements all compiles the code:
165+
The following commands installs the requirements and compiles the code:
166166

167167
```shell
168168
cd django-filer
@@ -198,7 +198,7 @@ operating system's graphical user interface. It is possible to …
198198
* Tag files and filter them by their tags.
199199

200200

201-
## Interface to external Django projects
201+
## Interface to other Django projects
202202

203203
**django-filer** (Finder branch) ships with a new file selection field. This field can be used in
204204
any Django model. It allows to select a file from the files stored inside **django-filer**. It also
@@ -218,10 +218,14 @@ class MyModel(models.Model):
218218
```
219219

220220
Forms generated from this model will have a file selection widget for the `my_file` field. When
221-
rendered as HTML, this widget is the webcomponent `<finder-file-select …></finder-file-select>`
221+
rendered as HTML, this widget becomes the webcomponent `<finder-file-select …></finder-file-select>`
222222
with a few additional attributes. The JavaScript part of the widget must be included using the
223223
script tag `<script src="{% static 'finder/js/finder-select.js' %}"></script>`.
224224

225+
The testapp provides an example how this field can be used in a form. Just vist the URL
226+
http://localhost:8000/admin/finder/foldermodel/ and click on the blank area to either select an
227+
existing file or upload a new one.
228+
225229

226230
## Further Steps
227231

0 commit comments

Comments
 (0)