Updated README

README.md

@@ -20,6 +20,8 @@ curl -L https://github.com/bovem/brag/releases/download/v0.1/brag-linux-amd64 >
 ```
 
 ## Setup and Usage
+
+### Initialize
 To initialize a bragging document directory create a Git repository on any provider
 like GitHub, GitLab, BitBucket, etc., and clone the repository locally. You can also
 create a local Git repository using `git init`.
@@ -36,6 +38,7 @@ using the `init` subcommand.
 brag init
 ```
 
+### Adding a new brag
 You can add your brags using the `-c`/`--comment` flag.
 ```bash
 brag -c "YOUR TEXT HERE"
@@ -44,6 +47,7 @@ brag -c "YOUR TEXT HERE"
 The brags will be added to the directory specified in the `BRAG_DOCS_LOC` environment
 variable.
 
+### Review your brags
 To review brags added in a given time period use subcommand `about`.
 ```bash
 brag about last-week
@@ -52,11 +56,7 @@ brag about last-week
 If the `BRAG_DOCS_REPO_SYNC` environment variable is set to `true` then new brags
 will be committed and pushed to the Git remote.
 
-## Todos
-- [ ] Add a `edit` subcommand to edit recent entries
-- [ ] Add a `summarize` subcommand to create a formatted bragging document using LLMs hosted on Ollama
-
-## Sample Output
+#### Sample Output
 ```text
 2024-01-02                                                                                                                                        
 * 11:12:50      Updated Quarterly Status Report
@@ -68,3 +68,85 @@ will be committed and pushed to the Git remote.
 2024-01-04
 * 17:39:50      Provisioned a new Kubernetes cluster
 ```
+
+### Summarize your brags using self hosted LLMs
+To summarize the accomplishments and build a draft for bragging document use the command
+`summarize` with a timeframe (similar to `about` command).
+```bash
+brag summarize last-month
+```
+If [Ollama](https://www.avni.sh/posts/homelab/self-hosting-ollama/) is deployed and the 
+`OLLAMA_URL` environment variables is pointing to your Ollama deployment then
+a draft bragging document will be generated on your terminal.
+
+Before generating the document the summarize command will ask for the names of your personal
+and work project, name of your blog and other content creation channels to differentiate 
+your work and personal updates in the summarized document.
+
+#### Sample Output
+```text
+Enter the name of your work projects:
+Enter the name of your personal projects:
+Enter the name of your blog, youtube or any other content creation channels:
+Draft Bragging Document
+
+Introduction:
+
+I am excited to share my accomplishments and growth over the past year with you, our esteemed manager and stakeholders. As an integral member of our team, I have been actively contributing to various projects, collaborating with colleagues, and learning new tools and technologies. This document highlights my work achievements, collaboration and mentorship efforts, design and documentation, company building, learning, and outside work contributions.
+
+Work Accomplishments:
+
+1. Project XYZ: As a member of the development team, I designed and built a comprehensive dashboard for monitoring client satisfaction. The dashboard has been instrumental in providing real-time insights into client feedback, enabling us to address their concerns promptly. (hyperlink to Jira ticket)
+2. Project ABC: I collaborated with the UX/UI team to redesign a critical feature of the application. My contributions included designing new layouts and providing constructive feedback during the user testing phase, resulting in an improved user experience. (hyperlink to design document)
+3. Project DEF: I contributed to the development of a mobile application for a client's business needs. My responsibilities included writing clean, efficient, and well-documented code, ensuring seamless functionality across various platforms. (hyperlink to pull request)
+
+Collaboration and Mentorship:
+
+1. Mentored an intern on the basics of web development, providing guidance on project management, coding best practices, and problem-solving techniques. The intern demonstrated significant improvement throughout the collaboration, showcasing their newfound skills. (hyperlink to mentorship session)
+2. Collaborated with cross-functional teams to develop innovative solutions for a client's complex business problem. Through active listening and ideation, we generated several potential ideas and approaches, which were well received by the team and stakeholders. (hyperlink to brainstorming session)
+3. Contributed to the creation of an internal knowledge transfer program, providing structured training sessions for new hires. This initiative enhanced the onboarding process, ensuring a smooth transition into our team's workflow. (hyperlink to knowledge transfer session)
+
+Design and Documentation:
+
+1. Created comprehensive design documents for each project, including wireframes, mockups, and style guides. These resources were instrumental in communicating design intent to the development team and stakeholders. (hyperlink to design document)
+2. Developed a standard operating procedure (SOP) for our team's documentation process, streamlining the creation and maintenance of technical documents. This initiative has resulted in increased efficiency and consistency across our projects. (hyperlink to SOP document)
+
+Company Building:
+
+1. Participated in the interviewing and recruiting process, contributing to the identification and hiring of top talent for our team. (hyperlink to job postings)
+2. Created an updated new hire guide, providing comprehensive information on our team's workflow, tools, and best practices. This document has been instrumental in ensuring a smooth transition for new team members. (hyperlink to new hire guide)
+3. Contributed to the development of internal training programs, enhancing the skills of our team members and fostering a collaborative learning environment. (hyperlink to training program)
+
+Learning:
+
+1. Expanded my knowledge of emerging technologies such as React Native, GraphQL, and Machine Learning. Through hands-on projects and collaboration with colleagues, I have gained a deeper understanding of these tools and their potential applications in our workflows. (hyperlink to personal project)
+2. Participated in industry events, conferences, and meetups, showcasing our team's work and engaging with peers. These experiences have provided valuable insights into the latest trends and innovations in our field. (hyperlink to event report)
+
+Outside of Work:
+
+1. Published articles on Hacker Noon and other industry platforms, sharing my experiences and insights on web development best practices. The articles have received positive feedback from peers and industry leaders, with several shares and likes on social media platforms. (hyperlink to article)
+2. Contributed to OpenSource projects, such as [insert project name], providing new features and enhancements that benefit the broader development community. (hyperlink to OpenSource project)
+3. Received recognition from industry leaders and peers for my work in web development, including a mention in [insert publication name] and an award at [insert event name]. (hyperlink to publication or event)
+
+Personal Projects:
+
+1. Developed a personal website showcasing my work and projects, serving as a portfolio and networking tool. (hyperlink to personal website)
+2. Created a blog focusing on web development best practices and emerging technologies, providing valuable insights and resources for the industry. (hyperlink to blog)
+3. Fostered a community of developers through social media platforms, sharing knowledge and collaborating on projects. (hyperlink to social media channel)
+
+Conclusion:
+In conclusion, I have demonstrated significant growth and achievements in my role as a web developer within the past year. Through active collaboration, mentorship, design and documentation, company building, learning, and outside work contributions, I have enhanced our team's workflows, fostered a culture of innovation and excellence, and expanded my skill set. I look forward to continuing to contribute to our team's success in the future.
+
+Additional Information:
+Personal Projects:
+
+* Website: [insert website link]
+* Blog: [insert blog link]
+* Social Media Channel: [insert social media channel link]
+
+Note: The above document is a draft and may require revisions based on your feedback. Please feel free to provide your inputs and suggestions, and I will be more than happy to incorporate them into the final document.
+```
+
+## Todos
+- [ ] Add a `edit` subcommand to edit recent entries
+- [x] Add a `summarize` subcommand to create a formatted bragging document using LLMs hosted on Ollama