diff --git a/.Rbuildignore b/.Rbuildignore index 5a7513e..d5eba41 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,5 @@ shinyRatings\.Rproj ^_pkgdown\.yml$ ^docs$ ^pkgdown$ +^README\.md$ +^NEWS\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index c3de9b6..70671f2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,10 @@ Package: shinyRatings -Title: An intuitive way of providing star rating on a shiny app -Version: 0.0.3 +Title: An Intuitive Way of Providing Star Rating in a 'shiny' App +Version: 0.1.0 Authors@R: person("Ronak", "Shah", , "shahronak47@yahoo.in", role = c("aut", "cre")) -Description: An intuitive way of providing star rating on a shiny app. +Description: A simple interface to integrate star ratings into your 'shiny' apps. + It can be used for customer feedback systems, user reviews, or any application that requires user ratings. + 'shinyRatings' offers a straightforward and customisable solution that enhances user engagement and facilitates valuable feedback collection. License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) diff --git a/NEWS.md b/NEWS.md index 7fd3047..86d73f3 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# shinyRatings 0.1.0 + +- [Make package ready for CRAN submission.](#17) + # shinyRatings 0.0.3 - [Add more than 1 shinyRating without disturbing each other](#15) diff --git a/README.md b/README.md index 4dd8db8..ad47c71 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,15 @@ library(shiny) library(shinyRatings) ui <- fluidPage( - shinyRatings('star'), - textOutput('text') + shinyRatings('star1', no_of_stars = 7, default = 5), + textOutput('text1'), + shinyRatings('star2',default = 3, disabled = TRUE), + textOutput('text2'), ) server <- function(input, output, session) { - output$text <- renderText({paste("No. of stars : ", input$star)}) + output$text1 <- renderText({paste("No. of stars : ", input$star1)}) + output$text2 <- renderText({paste("No. of stars : ", input$star2)}) } shinyApp(ui, server) @@ -28,7 +31,13 @@ shinyApp(ui, server) # Installation -To install the package you can use - +`shinyRatings` is available on CRAN and can be installed using - + +``` +install.packages("shinyRatings") +``` + +To install the package from GitHub, you can use - ``` devtools::install_github('shahronak47/shinyRatings') diff --git a/man/figures/output.gif b/man/figures/output.gif index 1a0af8e..76dc7b2 100644 Binary files a/man/figures/output.gif and b/man/figures/output.gif differ