Skip to content

Commit 4cb1ed5

Browse files
authored
Update README.md
Signed-off-by: Najaf Shaikh <ns4mail@gmail.com>
1 parent f37a26b commit 4cb1ed5

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# <img src="https://github.com/CodeShayk/abacus.net/blob/master/images/ninja-icon-16.png" alt="ninja" style="width:30px;"/> Abacus v1.0.0
1+
# <img src="https://github.com/CodeShayk/abacus/blob/master/images/ninja-icon-16.png" alt="ninja" style="width:30px;"/> Abacus v1.0.0
22
[![NuGet version](https://badge.fury.io/nu/abacus.svg)](https://badge.fury.io/nu/abacus) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/codeshayk/abacus/blob/master/License.md) [![build-master](https://github.com/codeshayk/abacus/actions/workflows/Build-Master.yml/badge.svg)](https://github.com/codeshayk/abacus/actions/workflows/Build-Master.yml) [![GitHub Release](https://img.shields.io/github/v/release/codeshayk/abacus?logo=github&sort=semver)](https://github.com/codeshayk/abacus/releases/latest)
3-
[![CodeQL](https://github.com/codeshayk/abacus/actions/workflows/codeql.yml/badge.svg)](https://github.com/codeshayk/abacus/actions/workflows/codeql.yml) [![.Net](https://img.shields.io/badge/.Net-8.0-blue)](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
3+
[![CodeQL](https://github.com/codeshayk/abacus/actions/workflows/codeql.yml/badge.svg)](https://github.com/codeshayk/abacus/actions/workflows/codeql.yml) [![.Net](https://img.shields.io/badge/.Net-8.0-blue)](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
44

55
Simple Workflow framework in .Net
66
> Allows creating workflow templates with tasks transitions, triggered by outcomes of constituent tasks and entity actions linked to workflow (such as create, update or delete of linked entity).
@@ -17,5 +17,30 @@ Simple Workflow framework in .Net
1717
### Example Workflow
1818
![Abscus.Example](images/abscus.example.png)
1919

20-
### Implementation
21-
- Please visit [wiki](https://github.com/CodeShayk/Abacus/wiki) pages for details.
20+
## Getting Started
21+
### Installation
22+
nuget add package SourceFlow.Net
23+
> - dotnet add package abacus
24+
> - dotnet add package abacus.SqlServer (to be released)
25+
> - or your preferred storage
26+
27+
### Developer Guide
28+
This comprehensive guide provides detailed information about the SourceFlow.Net framework, covering everything from basic concepts to advanced implementation patterns and troubleshooting guidelines.
29+
30+
Please click on [Developer Guide](https://github.com/CodeShayk/abacus/wiki) for complete details.
31+
## Support
32+
If you are having problems, please let me know by [raising a new issue](https://github.com/CodeShayk/abacus/issues/new/choose).
33+
34+
## License
35+
This project is licensed with the [MIT license](LICENSE).
36+
37+
## Contributing
38+
We welcome contributions! Please see our Contributing Guide for details.
39+
- 🐛 Bug Reports - Create an [issue](https://github.com/CodeShayk/abacus/issues/new/choose)
40+
- 💡 Feature Requests - Start a discussion
41+
- 📝 Documentation - Help improve our [docs](https://github.com/CodeShayk/abacus/wiki)
42+
- 💻 Code - Submit pull requests
43+
44+
## Credits
45+
Thank you for reading. Please fork, explore, contribute and report. Happy Coding !! :)
46+

0 commit comments

Comments
 (0)