Skip to content

Commit

Permalink
Update README and Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
diegotoral committed Nov 17, 2014
1 parent 3723171 commit 42001f4
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ Changelog
=========
---------

## version 0.2.0

- Fix for issue [#47](https://github.com/diegotoral/generator-django/issues/47)
- Generators to start app and create models (thanks matiboy)
- Ability to choose Django version (thanks matiboy)

## version 0.1.4

- Created the Changelog.md.
Expand Down
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,45 @@ $ mkdir myproject && cd myproject
$ yo django
```


## Generators

Available generators:

* django
* startapp
* model

**Note: Generators are to be run from the root directory of your app.**

### Django

Sets up a new Django project.

Example:
```sh
$ yo django
```

### Startapp

Sets up an app folder.

Example:
```sh
$ yo django:startapp
```

### Model

Generates a Django model for you.

Example:
```sh
$ yo django:model
```


## What do you get?

You get the following directory structure:
Expand Down Expand Up @@ -59,6 +98,7 @@ You get the following directory structure:
└── layout
```


## Contributing

1. Fork it
Expand All @@ -67,6 +107,7 @@ You get the following directory structure:
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request


## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)
Expand Down

0 comments on commit 42001f4

Please sign in to comment.