Skip to content

Commit

Permalink
docs: update repo logo
Browse files Browse the repository at this point in the history
  • Loading branch information
timeowilliams committed Aug 23, 2024
1 parent 911d4fa commit 1a297ca
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 5 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,25 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: npx semantic-release

update-badge:
needs: release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Get latest release version
id: get_version
run: |
VERSION=$(gh release list --limit 1 | cut -f1)
echo "::set-output name=version::$VERSION"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Create badge
uses: schneegans/dynamic-badges-action@v1.6.0
with:
auth: ${{ secrets.GIST_SECRET }}
gistID: <your-gist-id>
filename: deepfocus-version.json
label: version
message: ${{ steps.get_version.outputs.version }}
color: blue
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# DeepFocus

![DeepFocus Logo](resources/gaudmire-ig.png)
<p align="center">
<img src="resources/icon.png" alt="DeepFocus Logo" width="200" height="200">
</p>

[![Build Status](https://img.shields.io/travis/username/repo.svg)](https://travis-ci.org/username/repo)
[![Release](https://github.com/timeowilliams/deepFocus/actions/workflows/release.yml/badge.svg)](https://github.com/timeowilliams/deepFocus/actions/workflows/release.yml)
[![Version](https://img.shields.io/npm/v/project.svg)](https://www.npmjs.com/package/project)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

Expand Down Expand Up @@ -48,7 +50,7 @@ pnpm install

## Usage

[Add screenshots or examples here]


## Goals

Expand All @@ -58,6 +60,8 @@ pnpm install
- [x] Implement changelog using conventional commits
- [ ] Allow users to enter session goals and customize productive/unproductive sites
- [ ] Migrate from electron-storage to SQLite for improved data handling
- [ ] Add integration and automated tests
- [ ] Implement user authentication and cloud-based data persistence

## Philosophy

Expand All @@ -72,6 +76,9 @@ DeepFocus is built primarily for Software Engineers, Product Managers, and Desig
- Implement progress bar for deep work visualization
- Enhance data analysis and insights
- Improve user onboarding experience
- Develop comprehensive test suite for main and renderer processes
- Create cloud synchronization for user data and preferences
- Implement secure user authentication system

## Contributing

Expand All @@ -83,6 +90,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

## Contact

[Your Name] - [@your_twitter](https://twitter.com/your_twitter) - email@example.com
[Timeo Williams] - [@timeowilliams](https://twitter.com/timeowilliams) - timeo.williams@gmail.com

Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
Project Link: [https://github.com/timeowilliams/deepFocus](https://github.com/timeowilliams/deepFocus)

0 comments on commit 1a297ca

Please sign in to comment.