Skip to content

Commit

Permalink
docs(readme): update with project details and setup instructions
Browse files Browse the repository at this point in the history
Add a detailed description of the Origen efficiency assistant, including its purpose,
dependencies, and a quick start guide for new contributors.
The README now reflects project initialization, code generation, and business integration capabilities.
  • Loading branch information
godcong committed Aug 15, 2024
1 parent 154b7d4 commit 229a381
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
# template
# [Origen](https://github.com/origadmin/origen) efficiency assistant

> A OrigAdmin efficiency assistant that provides project initialization, code generation, business integration, improves work efficiency, and quickly completes the development process.
## Dependencies

- [Go](https://golang.org/) 1.22+
- [Wire](github.com/google/wire) `go install github.com/google/wire/cmd/wire@latest`
- [Swag](github.com/swaggo/swag) `go install github.com/swaggo/swag/cmd/swag@latest`

## Quick start

### Get and install

```bash
go install github.com/origadmin/origen@latest
```

### Initialize a new project

```bash
origen init -d ~/go/src
```

### Add more

## Contributing

See the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for details.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for the full license text.

## Code of Conduct

See the [CODE_OF_CONDUCT.md](.github/CODE_OF_CONDUCT.md) file for details.

## Contact

- [GitHub](https://github.com/origadmin)

0 comments on commit 229a381

Please sign in to comment.