update readme

giorgiopagnoni · Jan 26, 2018 · 3e9ba6d · 3e9ba6d
1 parent 7fd5ee5
commit 3e9ba6d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -9,3 +9,9 @@ skeleton for projects that require user registration and authentication with Sym
 * Optional double opt-in
 * Automatic login after user activation and password reset
 * Bootstrap 4 theme
+
+## Usage
+
+Set environment variables in .env; you'll need a db, a mailer and recaptcha keys.
+Then run  `php bin/console doctrine:database:create` and `php bin/console doctrine:migrations:migrate`.
+If you are using Apache you might need a `.htaccess` file.
diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "giorgiopagnoni/symfony4-user",
     "type": "project",
     "license": "MIT",
-    "description": "A minimal Symfony project recommended to create bare bones applications",
+    "description": "A minimal Symfony skeleton with user registration and authentication",
     "require": {
         "php": "^7.1.3",
         "ext-iconv": "*",